Skip to content

Development Setup

This setup is only intended for development purposes. If you are here to integrate the library into your project, follow the installation guide.

Ensure the following tools are installed on your machine:

First, clone the repository:

Terminal window
git clone [email protected]:Tofpu/MultiWorldEdit.git
cd MultiWorldEdit

Then, install dependencies and build the project locally:

Terminal window
mvn clean install -DskipTests

The project is now ready for development.

You can run the unit test suite with:

Terminal window
mvn test

To prepare a new release:

  1. Prepare the release locally:

    Terminal window
    mvn release:prepare -DignoreSnapshots=true -DpushChanges=false

    (Follow the prompts to specify the release version, Git tag, and next development version).

  2. Push the commits and tags to GitHub:

    Terminal window
    git push origin main --tags

Note: If a release attempt fails midway or needs to be reset, clean up the release state with:

Terminal window
mvn release:clean