Minecraft Development for IntelliJ

Build Status
Main Build
2024.2
2024.3
2025.1
OS Tests

Info and Documentation

<img" alt="Minecraftdev image">

Visit https://minecraftdev.org for some 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

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

IntelliJ includes a lot of dependencies transitively, including common dependencies that are used a lot, such as Kotlin, Commons Lang3, Guava, etc. Unfortunately, the source distribution for IntelliJ does not contain sources for libraries as well, so these libraries are imported into the IDE without sources by default. If you want to attach sources for (most) of the dependencies IntelliJ includes, run the resolveIntellijLibSources task and refresh the Gradle project in IntelliJ:

./gradlew resolveIntellijLibSources

If you're curious about that task, it is implemented in buildSrc.

Developers

• Project Owner - @DenWav - Kyle Wood
• @Minecrell
• @PaleoCrafter - Marvin Rösch
• @RedNesto
• @Earthcomputer - Joseph Burton

Significant Contributors

• @gabizou - Gabriel Harris-Rouquette
• @kashike - Riley Park
• @jamierocks - Jamie Mansfield

License

This project is licensed under LGPLv3.0-only.

Supported Platforms

• Spigot ( Paper)
• Sponge
• Architectury
• Minecraft Forge
• <img/ alt="Minecraftdev image"> Neoforge
• Fabric
• Mixins
• BungeeCord ( Waterfall)
• Velocity
• Adventure