Setup

You must have Java 17 and Java 8 installed on your system to run various scripts and compilation steps.

1. Install Java 17 (Amazon Corretto)
2. Install Java 8. I recommend downloading the LTS JDK 8 from AdoptOpenJDK.
3. Run python3 scripts/download_dev_server.py to download the development server.
4. Run python3 scripts/dev_server.py to compile the plugin and run the development server.
5. You are ready to start developing! Simply rerun the development server script to refresh any changes.

Running Spigot buildtools

You must run the buildtools.py script to build the Spigot and CraftBukkit Maven repositories. Ensure you are using Java 8 or Java 7 to run the script.

python scripts/buildtools.py

For Windows Developers

By default, the script will use java from the JAVA_HOME environment variable to locate the Java executable. If you want to override the Java executable, set the BUILD_TOOLS_JAVA_PATH environment variable to the full path of the Java executable. For example:

# Powershell
$env:BUILD_TOOLS_JAVA_PATH = "C:\Program Files\Java\jdk1.8.0_202\bin\java.exe"; python scripts/buildtools.py

# CMD
set "BUILD_TOOLS_JAVA_PATH=C:\Program Files\Java\jdk1.8.0_202\bin\java.exe" && python scripts\buildtools.py

Local Database (DynamoDB)

1. Ensure you have docker and docker-compose installed on your system.
2. Run docker-compose up in the dynamodb directory to start the local DynamoDB instance.
3. Run the reset_schema.py script in scripts/db/reset_schema.py. This will delete any pre-existing data and recreate a fresh environment.