Earthcomputer / MinecraftDev

Plugin for IntelliJ IDEA that gives special support for Minecraft modding projects.

Home Page:https://minecraftdev.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Minecraft Development for IntelliJ

Info and Documentation

This is Earthcomputer's fork of the Minecraft Development plugin for IntelliJ. The main additional features are:

  • Fabric project generation

Planned features include:

  • Changing existing inspections to support Fabric naming
  • Making inspections more customizable, e.g. specifying methods for translations inspections to apply to
  • Bug fixes
  • Mixin generators
  • Further enhancements to mixin support

Visit https://minecraftdev.org for a little information about the official project.

Installation

  1. Go into the plugins menu in IntelliJ (Settings -> Plugins)
  2. Click the gear icon on the top, and click "Manage Plugin Repositories"
  3. Add a raw GitHub link to the update file in the updates directory, corresponding to the version of IntelliJ you have. For example, if you have 2019.3, use https://raw.githubusercontent.com/Earthcomputer/MinecraftDev/dev_new/updates/updatePlugins-193.xml
  4. MinecraftDev should now show an update if you have the official version installed, which corresponds to Earth's edition of MinecraftDev. If you didn't have the official version installed, installing MinecraftDev will also install Earth's edition.
  5. Lately (as of April 2020) some people seem to be having issues getting IDEA to recognize the plugin updates. You can instead install it manually from the zip. You can find a direct download to the zip in the update xml pretty easily (it's pretty obvious where it is).

Installation instructions for the official project:

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

Contributors

License

This project is licensed under MIT.

Supported Platforms

About

Plugin for IntelliJ IDEA that gives special support for Minecraft modding projects.

https://minecraftdev.org/

License:MIT License


Languages

Language:Kotlin 97.8%Language:Lex 1.0%Language:HTML 0.8%Language:Groovy 0.3%Language:Java 0.1%Language:Shell 0.1%