-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add README.md, LICENSE, CONTRIBUTING.md and contributors.txt
- Loading branch information
1 parent
744d5a1
commit e112d76
Showing
4 changed files
with
64 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
## Contributing | ||
|
||
- Avoid using code from other mods, if you do, **please** make sure you have permission from the respective mod's developers | ||
- Try and keep the indentation to tabs rather than spaces | ||
- Keep code consistent | ||
- Avoid mixins where possible - we don't want to be too invasive. | ||
- Make sure your PRs build before making them! This is incredibly important, we can't merge broken pull requests! | ||
> [!NOTE] | ||
> Contributors and developers get a cape, if you make a PR you are allowed to modify `contributors.txt` and add your Minecraft account's UUID. To get the UUID you can go to [namemc](https://namemc.com/) and search for it. If you contribute in other ways that don't involve committing directly to this repository, contact someone in the [discord server](https://discord.gg/JBVHbYtTRS). | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Minecraft-Propulsive | ||
![Static Badge](https://img.shields.io/badge/latest_mc_version-1.20.1-blue) | ||
![GitHub issues](https://img.shields.io/github/issues/Team-Propulsive/Minecraft-Propulsive?color=green) | ||
![GitHub pull requests](https://img.shields.io/github/issues-pr/Team-Propulsive/Minecraft-Propulsive?color=yellow) | ||
![Discord](https://img.shields.io/discord/1134210976632283156?logo=discord&color=%235865F2) | ||
[![Crowdin](https://badges.crowdin.net/propulsive/localized.svg)](https://crowdin.com/project/propulsive) | ||
|
||
|
||
<img alt="Requires Fabric API" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/requires/fabric-api_vector.svg"> <img alt="Available for Quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg"> <a href="https://discord.gg/JBVHbYtTRS" ><img alt="Chat with us on the Propulsive Discord" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg"></a> <a href="https://crowdin.com/project/propulsive/"><img alt="Translate on Crowdin" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/translate/crowdin_vector.svg"></a> | ||
|
||
<a href="https://legacy.curseforge.com/minecraft/mc-mods/propulsive"><img alt="curseforge" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg"></a> <a href="https://modrinth.com/mod/propulsive/"><img alt="modrinth" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg"></a> | ||
|
||
|
||
Going to space one block at a time! | ||
|
||
> [!IMPORTANT] | ||
> [Contribution guidelines](CONTRIBUTING.md) | ||
> [!WARNING] | ||
> Currently the mod is **in development** and there is no planned release date - it is ready when it is ready. You can contribute code, art, music, etc here on github. | ||
|
||
## FAQ | ||
|
||
### What is this mod about? | ||
|
||
Propulsive is a Minecraft mod that plans to bring a much more interactive environment - Most other mods lack the ability to explore space itself, they usually have some kind of a map screen and you select where you want to go. Propulsive allows you to physically travel to you destination as well as build stuff in space! | ||
|
||
|
||
## Building | ||
|
||
The mod requires nothing special to build. You can simply clone the mod and run the following: | ||
|
||
`./gradlew build` (Linux) | ||
|
||
`gradlew.bat build` (Windows) | ||
|
||
However, doing this means there is more than likely going to be many problematic bugs/issues, so be warned! It is recommended to stick to the builds in the releases tab, or use the ones on Modrinth/Curseforge (As of writing, the mod is not on Curseforge or Modrinth yet) | ||
|
||
Contributors: | ||
|
||
<a href="https://github.com/Team-Propulsive/Minecraft-Propulsive/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=Team-Propulsive/Minecraft-Propulsive" /> | ||
</a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
668782eb-a387-49ae-85fd-2aec43e39494 | ||
047f4662-74dc-4d24-bfbc-a310fab86b4f | ||
56edfc1e-069d-4375-83c8-ea0f9ba98f65 | ||
986d838b-e6f3-4b49-a34c-1984e8b3d62e |