Void docs — IDE Setup

Development

Use IntelliJ (which is free to use) to develop with Void. See the installation guide for more instructions.

Once opened the IDE click the Clone Repository button or File | New | Project from version control... | if in the full application.

Select git and enter the project URL (Found under the <> Code button on the GitHub page).

git@github.com:GregHib/void.git if you have GitHub authentication setup.
https://github.com/GregHib/void.git if you don't have SSH authentication.

Note

When git is not installed it will display an error and the option to "Download and install", click this and retry the previous step. Click "Trust Project" if also asked.

Press "clone" and after the download is complete the project will be opened for you.

Under Project Structure... | Project settings set SDK to JDK 21+ (download as needed) and let it index.

Run the following command in the terminal to set up Gradle or close and re-open the project to trigger IntelliJ's Open as Gradle Project popup.

./gradlew build -x test

Extract the cache files into a new directory called /cache/ inside of the /data/ directory.

From here you can navigate in the left panel to /game/src/main/kotlin/ (Or Ctrl/Cmd + N for class search) where you will find Main.kt which you should be able to right-click and run.

You can also run in the command line using the gradle wrapper.

./gradlew run

Once the server is up and running; download one of the prebuilt client.jars or set up the void-client repository and run to log into the game.

Remember to check out our Contributing guidelines before submitting your first pull request!

Run spotless before commiting to ensure formatting is correct:

./gradlew spotlessApply

Tip

There are instructions on how to build your own client and build your own cache!