Minecraft Development for IntelliJ

Service	Status
TeamCity
Nightly
CircleCI
Travis

Info and Documentation

Visit https://minecraftdev.org for information about the project, change logs, features, FAQs, and chat.

Installation

This plugin is available on the JetBrains IntelliJ plugin repository.

Because of this, you can install the plugin through IntelliJ's internal plugin browser. Navigate to File -> Settings -> Plugins and click the Browser Repositories... button at the bottom of the window. In the search box, simply search for Minecraft and this plugin will be the only result it shows. You can install it from there and restart IntelliJ to activate the plugin.

Building

Make sure you have Java 8 installed.

Build the plugin with:

./gradlew build

The output .zip file for the plugin will be in build/distributions.

Test the plugin in IntelliJ with:

./gradlew runIde

Code is generated during the build task, to run the generation task without building use:

./gradlew generate

This task is necessary to work on the code without errors before the initial build.

The Gradle IntelliJ Plugin will handle downloading the IntelliJ dependencies and packaging the plugin.

IDE Setup

Copy the contents of the idea-configs directory into your .idea directory to quickly setup useful run configurations and copyright settings.

Style Guide

This project will follow DemonWav's Java style guidelines (lol, Google's style slightly modified). Link here.

Developers

@DemonWav - Kyle Wood

Contributors

• @gabizou - Gabriel Harris-Rouquette
• @kashike
• @Minecrell
• @jamierocks - Jamie Mansfield

Issues

We have a few ambiguous labels on the issues page, so here are their definitions:

• platform: all - An issue which applies to all supported platforms (Bukkit, Sponge, BungeeCord, Forge, LiteLoader, and Canary)
• platform: main - Multiple platforms, containing at least Bukkit, Sponge, and Forge. It can contain either of the other two as well, as long as it doesn't contain all of them. In that case, platform: all would be more appropriate, of course.
• platform: multi - Any issue with more than two platforms which doesn't fall under the first two categories.

License

This project is licensed under MIT.

Supported Platforms

• Bukkit ( Spigot and Paper)
• Sponge
• Minecraft Forge
• LiteLoader
• MCP
• Mixins
• BungeeCord
• Canary ( Neptune)