Skip to content

IDE/Project Setup

Recommended IDE: IntelliJ

It has solid Kotlin support and we will only be able to help you resolve IDE problems in IntelliJ.

Once installed, Set up your JDK to use the latest OpenJDK version.

Setting up a project

Clone a project from GitHub and open it in IntelliJ. From there, it should start importing it as a Gradle project and you'll soon get syntax highlighting and be able to build your project.

Note: Working on multiple projects

You may use our composite master project to open several projects at once. Note it slows down build times, so you may wish to limit yourself to one at a time.

Building

You do not need to install anything to build. You can do it from command line or IntelliJ (running builds through IntelliJ will be more convenient)

From a terminal

cd <insert project directory here>
gradlew.bat build
cd <insert project directory here>
./gradlew build

In IntelliJ

This video shows how to run Gradle tasks like build, as well as how to work with Gradle in general. Feel free to watch the short clip or full video.

You can also find documentation here.

Automatically copy our build

Tip

Normally, running gradle build produces several jar files in a build/libs folder. If you are running a local server, copying them every time gets annoying, so we have an automated solution.

Specify a plugin_path in our global Gradle configuration and all our plugins will automatically copy to it:

  • Create/open ~/.gradle/gradle.properties (~ being your user directory).
  • Add plugin_path=path/to/my/server/plugins.
  • Ensure you use / and not \.