Skip to content

Commit

Permalink
add README.md, LICENSE, CONTRIBUTING.md and contributors.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
Haskellered committed Dec 30, 2023
1 parent 744d5a1 commit e112d76
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 6 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
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).
12 changes: 6 additions & 6 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)
MIT License

Copyright (c) 2023
Copyright (c) 2023 Team Propulsive & Contributors (All owners of https://github.com/TeamPropulsive and contributors in relevant repositories)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
44 changes: 44 additions & 0 deletions README.md
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>
4 changes: 4 additions & 0 deletions contributors.txt
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

0 comments on commit e112d76

Please sign in to comment.