Skip to content

First Steps

Quick start

One command creates a new addon from our template and prepares it for AI coding agents like Claude Code, Codex and Gemini CLI.

irm https://dev.labymod.net/new-addon.ps1 | iex
curl -fsSL https://dev.labymod.net/new-addon.sh | sh

The script:

  • checks for JDK 25, Node.js and Git and asks before it installs anything that is missing (with winget on Windows, Homebrew on macOS and apt, dnf or pacman on Linux)
  • asks for your addon's name, namespace, author and main package
  • downloads the addon template and renames it to your addon
  • sets up the tools AI agents use to look up the LabyMod API and this wiki, check your addon against the publishing guidelines and test it in the running game

You can read both scripts before you run them: new-addon.ps1, new-addon.sh.

Start the game from the project folder with ./gradlew :game-runner:client_v<version>, for example ./gradlew :game-runner:client_v26.1.2. To debug it, open the project in IntelliJ IDEA.

Manual setup

First you'll need a Java IDE, as of now we only support IntelliJ IDEA. Then download JDK (Java Development Kit) 25 if you haven't already.

Differences between the "Community" and "Ultimate" edition:

  • IntelliJ IDEA Community Edition is the free to use version for everyone.
  • IntelliJ IDEA Ultimate is the version where you need a valid subscription based license.

You can apply for a free educational license at Jetbrains here.
Its also possible obtain an "Ultimate" edition license if you are part of the GitHub Global Campus where you can apply here.

Now download or clone our addon template and open it in your preferred IDE.

todo: fill with basic information