Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.41 KB

README.md

File metadata and controls

28 lines (23 loc) · 1.41 KB
Raw

Carpet Mod

Yes.

Getting Started

Setting up your sources

  • Clone this repository.
  • Run gradlew setupCarpetmod in the root project directory.

Using an IDE

  • To use Eclipse, run gradlew eclipse, then import the project in Eclipse.
  • To use Intellij, run gradlew idea, then import the project in Intellij.

Using the build system

Edit the files in the src folder, like you would for a normal project. The only special things you have to do are as follows:

To generate patch files so they show up in version control

Use gradlew genPatches

To apply patches after pulling

Use gradlew setupCarpetmod. It WILL overwrite your local changes to src, so be careful.

To create a release / patch files

In case you made changes to the local copy of the code in src, run genPatches to update the project according to your src. Use gradlew createRelease. The release will be a ZIP file containing all modified classes, obfuscated, in the build/distributions folder.

To run the server locally (Windows)

Use mktest.cmd to run the modified server with generated patches as a localhost server. It requires gradlew createRelease to finish successfully as well as using default paths for your minecraft installation folder.

In case you use different paths, you might need to modify the build script. This will leave a ready server jar file in your saves folder.

It requires to have 7za installed in your paths