$git clone https://github.com/minecraft-dev/MinecraftDevMinecraft Development for IntelliJ ==================================
| 1 | <p align="center"><a href="https://mcdev.io/"><img src="https://mcdev.io/assets/icon.svg" height="120" alt="logo"/></a></p> |
| 2 | |
| 3 | Minecraft Development for IntelliJ |
| 4 | ================================== |
| 5 | |
| 6 | <table> |
| 7 | <tr> |
| 8 | <td align="center" colspan="3"><b>Build Status</b></td> |
| 9 | </tr> |
| 10 | <tr> |
| 11 | <td align="right"><b>Main Build</b></td> |
| 12 | <td colspan="2"><a href="https://ci.mcdev.io/viewType.html?buildTypeId=MinecraftDev_Build"><img src="https://ci.mcdev.io/app/rest/builds/buildType:(id:MinecraftDev_Build)/statusIcon.svg" alt="Teamcity Build Status" /></a></td> |
| 13 | </tr> |
| 14 | <tr> |
| 15 | <td align="left">2025.3</td> |
| 16 | <td align="left"><a href="https://ci.mcdev.io/viewType.html?buildTypeId=MinecraftDev_Nightly_20253"><img src="https://ci.mcdev.io/app/rest/builds/buildType:(id:MinecraftDev_Nightly_20253)/statusIcon.svg" alt="2025.3 Nightly Status" /></a></td> |
| 17 | </tr> |
| 18 | <tr> |
| 19 | <td align="left">2026.1</td> |
| 20 | <td align="left"><a href="https://ci.mcdev.io/viewType.html?buildTypeId=MinecraftDev_Nightly_20261"><img src="https://ci.mcdev.io/app/rest/builds/buildType:(id:MinecraftDev_Nightly_20261)/statusIcon.svg" alt="2026.1 Nightly Status" /></a></td> |
| 21 | </tr> |
| 22 | <tr> |
| 23 | <td align="left">2026.2</td> |
| 24 | <td align="left"><a href="https://ci.mcdev.io/viewType.html?buildTypeId=MinecraftDev_Nightly_20262"><img src="https://ci.mcdev.io/app/rest/builds/buildType:(id:MinecraftDev_Nightly_20262)/statusIcon.svg" alt="2026.2 Nightly Status" /></a></td> |
| 25 | </tr> |
| 26 | <tr> |
| 27 | <td align="left"><b>OS Tests</b></td> |
| 28 | <td align="left" colspan="2"> |
| 29 | <a href="https://github.com/minecraft-dev/MinecraftDev/actions?query=workflow%3A%22Test%22"><img src="https://github.com/minecraft-dev/MinecraftDev/workflows/Test/badge.svg?branch=dev&event=push" alt="GitHub Action Status" /></a> |
| 30 | </td> |
| 31 | </tr> |
| 32 | </table> |
| 33 | |
| 34 | Info and Documentation [](https://plugins.jetbrains.com/plugin/8327) |
| 35 | ---------------------- |
| 36 | |
| 37 | <a href="https://discord.gg/j6UNcfr"><img src="https://i.imgur.com/JXu9C1G.png" height="48px"></img></a> |
| 38 | |
| 39 | Visit [https://mcdev.io](https://mcdev.io) for some information about the project. |
| 40 | |
| 41 | |
| 42 | Installation |
| 43 | ------------ |
| 44 | |
| 45 | This plugin is available on the [JetBrains IntelliJ plugin repository](https://plugins.jetbrains.com/plugin/8327). |
| 46 | |
| 47 | Because of this, you can install the plugin through IntelliJ's internal plugin browser. Navigate to |
| 48 | `File -> Settings -> Plugins` and click the `Browse Repositories...` button at the bottom of the window. In the search |
| 49 | box, simply search for `Minecraft`. You can install it from there and restart IntelliJ to activate the plugin. |
| 50 | |
| 51 | Dependencies |
| 52 | ------------ |
| 53 | |
| 54 | Gradle will download all necessary dependencies to build the project, but you do need JDK 21 installed and available to |
| 55 | Gradle in order to build. |
| 56 | |
| 57 | You can easily install JDK 21 from [Adoptium](https://adoptium.net/temurin/releases). |
| 58 | |
| 59 | Building |
| 60 | -------- |
| 61 | |
| 62 | Build the plugin with: |
| 63 | |
| 64 | `./gradlew build` |
| 65 | |
| 66 | The output .zip file for the plugin will be in `build/distributions`. |
| 67 | |
| 68 | Test the plugin in IntelliJ with: |
| 69 | |
| 70 | `./gradlew runIde` |
| 71 | |
| 72 | Code is generated during the build task, to run the generation task without building use: |
| 73 | |
| 74 | `./gradlew generate` |
| 75 | |
| 76 | This task is necessary to work on the code without errors before the initial build. |
| 77 | |
| 78 | To format the code in this project: |
| 79 | |
| 80 | `./gradlew format` |
| 81 | |
| 82 | This will format using `ktlint` described below in the [style guide](#style-guide) section below. |
| 83 | |
| 84 | The [Gradle IntelliJ Plugin](https://github.com/JetBrains/gradle-intellij-plugin) |
| 85 | will handle downloading the IntelliJ dependencies and packaging the |
| 86 | plugin. |
| 87 | |
| 88 | Style Guide |
| 89 | ----------- |
| 90 | |
| 91 | This projects follows the opinionated [`ktlint`](https://ktlint.github.io/) linter and formatter. It uses the |
| 92 | [`ktlint-gradle`](https://github.com/jlleitschuh/ktlint-gradle) plugin to automatically check and format the code in |
| 93 | this repo. |
| 94 | |
| 95 | IDE Setup |
| 96 | --------- |
| 97 | |
| 98 | It's recommended t |