Minecraft Development for IntelliJ
| Build Status | ||
| Main Build | /statusIcon.svg) |
|
| Nightly Builds | 2019.3 | /statusIcon.svg) |
| 2020.1 | /statusIcon.svg) |
|
| OS Tests |
|
|
Info and Documentation 
Visit https://minecraftdev.org for a little information about the project.
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 Browse Repositories... button at the bottom of the window. In the search
box, simply search for Minecraft. You can install it from there and restart IntelliJ to activate the plugin.
Building
JDK 8 is required.
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.
To format the code in this project:
./gradlew format
This will format using ktlint described below in the style guide section below.
The Gradle IntelliJ Plugin will handle downloading the IntelliJ dependencies and packaging the plugin.
Style Guide
This projects follows the opinionated ktlint linter and formatter. It uses the
ktlint-gradle plugin to automatically check and format the code in
this repo.
IDE Setup
It's recommended to run the ktlintApplyToIdea and addKtlintFormatGitPreCommitHook tasks to configure your
IDE with ktlint style settings and to automatically format this project's code before committing:
./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook
Developers
- Project Owner - @DemonWav - Kyle Wood
- @Minecrell
- @PaleoCrafter - Marvin Rösch
- @RedNesto
Significant Contributors
License
This project is licensed under MIT.
Supported Platforms
Bukkit (
Spigot and 
Paper)
Sponge
Minecraft Forge
LiteLoader
MCP
Mixins
BungeeCord (
Waterfall)