|
| 1 | +Sponge [](https://travis-ci.org/SpongePowered/Sponge) |
| 2 | +============= |
| 3 | +**Currently not stable and under heavy development!** |
| 4 | +A Forge implementation of the Sponge API. It is licensed under the [MIT License]. |
| 5 | + |
| 6 | +* [Homepage] |
| 7 | +* [Source] |
| 8 | +* [Issues] |
| 9 | +* [SpongeAPI Wiki] |
| 10 | +* [Sponge Wiki] |
| 11 | +* [Community Chat]: #sponge on irc.esper.net |
| 12 | +* [Development Chat]: #spongedev on irc.esper.net |
| 13 | + |
| 14 | +## Prerequisites |
| 15 | +* [Java] 6 |
| 16 | + |
| 17 | +## Clone |
| 18 | +The following steps will ensure your project is cloned properly. |
| 19 | +1. `git clone --recursive https://github.com/SpongePowered/Sponge.git` |
| 20 | +2. `cd Sponge` |
| 21 | +3. `cp scripts/pre-commit .git/hooks` |
| 22 | + |
| 23 | +## Setup |
| 24 | +__Note:__ If you do not have [Gradle] installed then use ./gradlew for Unix systems or Git Bash and gradlew.bat for Windows systems in place of any 'gradle' command. |
| 25 | + |
| 26 | +__For [Eclipse]__ |
| 27 | + 1. Run `gradle setupDecompWorkspace --refresh-dependencies` |
| 28 | + 2. Run `gradle eclipse` |
| 29 | + 3. Import Sponge as an existing project (File > Import > General) |
| 30 | + 4. Select the root folder for Sponge and make sure `Search for nested projects` is enabled |
| 31 | + 5. Check Sponge when it finishes building and click **Finish** |
| 32 | + |
| 33 | +__For [IntelliJ]__ |
| 34 | + 1. Run `gradle setupDecompWorkspace --refresh-dependencies` |
| 35 | + 2. Make sure you have the Gradle plugin enabled (File > Settings > Plugins). |
| 36 | + 3. Click File > New > Project from Existing Sources > Gradle and select the root folder for Sponge. |
| 37 | + |
| 38 | +## Contributing |
| 39 | +Are you a talented programmer looking to contribute some code? We'd love the help! |
| 40 | +* Open a pull request with your changes, following our [guidelines](CONTRIBUTING.md). |
| 41 | +* Please follow the above guidelines for your pull request(s) to be accepted. |
| 42 | + |
| 43 | +[Eclipse]: http://www.eclipse.org/ |
| 44 | +[Gradle]: http://www.gradle.org/ |
| 45 | +[Homepage]: http://spongepowered.org/ |
| 46 | +[IntelliJ]: http://www.jetbrains.com/idea/ |
| 47 | +[Issues]: http://issues.spongepowered.org/ |
| 48 | +[SpongeAPI Wiki]: https://github.com/SpongePowered/SpongeAPI/wiki/ |
| 49 | +[Sponge Wiki]: https://github.com/SpongePowered/Sponge/wiki/ |
| 50 | +[Java]: http://java.oracle.com/ |
| 51 | +[Source]: https://github.com/SpongePowered/Sponge/ |
| 52 | +[MIT License]: http://www.tldrlegal.com/license/mit-license |
| 53 | +[Community Chat]: https://webchat.esper.net/?channels=sponge |
| 54 | +[Development Chat]: https://webchat.esper.net/?channels=spongedev |
0 commit comments