Sponge

The SpongeAPI implementation targeting vanilla Minecraft and 3rd party platforms. It is licensed under the MIT License.

• Homepage
• Source
• Issues
• Documentation
• Discord: [#sponge ]

Latest Builds

Sponge

1.16.4:

SpongeVanilla

1.16.4:

Prerequisites

• Java 8

Clone

The following steps will ensure your project is cloned properly.

1. git clone --recursive https://github.com/SpongePowered/Sponge.git
2. cd Sponge
3. cp scripts/pre-commit .git/hooks

Setup

Note: Sponge uses Gradle as its build system. The repo includes the Gradle wrapper that will automatically download the correct Gradle version. Local installations of Gradle may work but are untested. To execute the Gradle wrapper, run the ./gradlew script on Unix systems or only gradlew on Windows systems.

Before you are able to build Sponge, you must first prepare the environment (some IDEs may do this for you).

• Run ./gradlew build --refresh-dependencies

Even if this fails to compile Sponge, it will download all the dependencies so you can get started.

IDE Setup

For Eclipse

1. Run ./gradlew eclipse
2. Import Sponge as an existing project (File > Import > General)
3. Select the root folder for Sponge and make sure Search for nested projects is enabled
4. Check Sponge when it finishes building and click Finish

For IntelliJ

1. Make sure you have the Gradle plugin enabled (File > Settings > Plugins).
2. Click File > New > Project from Existing Sources > Gradle and select the root folder for Sponge.
3. Make sure Use default gradle wrapper is selected. Older/newer Gradle versions may work but we only test using the wrapper.

Building

Note: You must Setup the environment before you can build Sponge.

In order to build Sponge you simply need to run the gradlew command. On Windows systems you should run gradlew instead of ./gradlew to invoke the Gradle wrapper. You can find the compiled JAR files in ./build/libs.

Updating your Clone

The following steps will update your clone with the official repo.

1. git pull
2. git submodule update --recursive
3. ./gradlew build --refresh-dependencies

Contributing

Are you a talented programmer looking to contribute some code? We'd love the help!

• Open a pull request with your changes, following our guidelines.
• Please follow the above guidelines for your pull request(s) to be accepted.