LynxClient Docs

Appearance

Getting started ​

You need Java 17 or newer and the LynxClient launcher. You do not need Minecraft's source code or a Fabric development setup. Addons only compile against the Lynx API.

1. Get the template ​

The template is a complete Gradle project with one HUD widget: Official-LynxClient/lynx-addon-template. Click Use this template on GitHub (or download it as a zip) and rename it:

my-addon/
  build.gradle.kts
  settings.gradle.kts
  gradle.properties                     lynx_api = 0.1.17
  src/main/java/com/example/myaddon/
    MyAddon.java                        entry point
    HelloWidget.java                    a "Hello  world" HUD widget
  src/main/resources/
    fabric.mod.json                     id, name, entry point
    assets/my-addon/lang/en_us.json     texts
    assets/my-addon/lang/de_de.json

Change these three things first:

  1. id and name in fabric.mod.json. The id must be unique, lowercase, a-z 0-9 - _.
  2. The package com.example.myaddon and the entry point in fabric.mod.json.
  3. The module id in HelloWidget (my_addon_hello). Prefix module ids with your addon name.

The API comes from our Maven repository:

kotlin
repositories { maven("https://download.lynxclient.de/maven") }
dependencies { compileOnly("net.lynxclient:lynx-api:0.1.17") }

Always use compileOnly: LynxClient brings the API at runtime. Build for Java 17 (options.release = 17), because 1.8.9 runs on Java 17.

2. Build ​

bash
./gradlew build

The jar is in build/libs/.

3. Try it in game ​

  1. In the launcher, open Settings → Developer and turn on Load unsigned addons. Without this, LynxClient only loads addons from the store.
  2. Open Addons → Open folder and copy your jar into it. The folder is shared by all profiles.
  3. Start any profile with LynxClient. Your addon shows up in the mod menu (right Shift, or Esc → LynxClient) under Addons, its modules carry an Addon tag.

If something is wrong, the Addons page says why: wrong API version, not for this Minecraft version, a missing dependency or an error while loading (details in the game log).

Developer option

Unsigned addons were not reviewed by us and can do anything on the PC. Only turn the option on for your own builds, and turn it off again when you are done.

4. Publish ​

When it works, submit it to the store: Publishing.