Minecraft Development for IntelliJ ==================================

Build Status
Main Build
2025.3
2026.1
2026.2
2026.3
OS Tests

Info and Documentation [](https://plugins.jetbrains.com/plugin/8327) ---------------------- Visit [https://mcdev.io](https://mcdev.io) for some information about the project. Installation ------------ This plugin is available on the [JetBrains IntelliJ plugin repository](https://plugins.jetbrains.com/plugin/8327). 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. Dependencies ------------ Gradle will download all necessary dependencies to build the project, but you do need JDK 21 installed and available to Gradle in order to build. You can easily install JDK 21 from [Adoptium](https://adoptium.net/temurin/releases). 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](#style-guide) section below. The [Gradle IntelliJ Plugin](https://github.com/JetBrains/gradle-intellij-plugin) will handle downloading the IntelliJ dependencies and packaging the plugin. Style Guide ----------- This projects follows the opinionated [`ktlint`](https://ktlint.github.io/) linter and formatter. It uses the [`ktlint-gradle`](https://github.com/jlleitschuh/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 ``` License ------- This project is licensed under [LGPLv3.0-only](license.txt). Supported Platforms ------------------- - [ **Spigot**](https://spigotmc.org/) ([ Paper](https://papermc.io/)) - [ **Sponge**](https://www.spongepowered.org/) - [ **Architectury**](https://github.com/architectury/architectury-api) - [ **Minecraft Forge**](https://forums.minecraftforge.net/) - Neoforge - [ **Fabric**](https://fabricmc.net) - [ **Mixins**](https://github.com/SpongePowered/Mixin) - [ **BungeeCord**](https://www.spigotmc.org/wiki/bungeecord/) ([ Waterfall](https://github.com/PaperMC/Waterfall)) - [ **Velocity**](https://velocitypowered.com/) - [ **Adventure**](https://kyori.net/)