Setting Up Tips

Running Glowstone in your IDE

When you run Glowstone in your IDE, depending on your configuration, you might not be able to type anything into the console.

This happens because of the library jline. This library thinks the console of your IDE isn't supported.

Just add to the VM options / parameters the parameter -Djline.terminal=jline.UnsupportedTerminal. Then it should work.

IntelliJ is slow/freezes

This is a bug with Gradle and the Package Search plugin. Try disabling the Package Search plugin in IntelliJ before using the project.

Java

Glowstone requires Java 8 update 101 or later. We also have support for developing/building on up to Java 17.

Lombok

Glowstone uses Lombok, a pre-processor for its code. If you are using an IDE, such as Eclipse or IntelliJ IDEA, you will need to install a Lombok plugin.

• IntelliJ
• Eclipse
• Netbeans
• Visual Studio Code
• More plugins listed on the Lombok website, under Install > IDEs

Checkstyle

We use Checkstyle to check and enforce our code style. If you are using an IDE, you can install a checkstyle plugin to help you conform your settings to the project's.

• IntelliJ
• Eclipse
• Netbeans
• Visual Studio Code
• More plugins/tools listed on the Checkstyle website

Permissions

The permission structure for the files is as follows:

• Directories have the permission 744
• Files have the permission 644

Maven

Maven 3.3.9 or later must be used. Earlier versions will fail.

Code Style

Please make sure to read up on the Code Style.