Introduction

LynxClient is a Minecraft client with its own in-game menu, HUD editor and modules (FPS, keystrokes, zoom, toggle sprint …). Addons extend it with your own modules and HUD widgets.

How addons work

• An addon is a small jar with a fabric.mod.json. Fabric Loader loads it next to LynxClient (on 1.8.9 through Ornithe, which uses Fabric Loader as well.
• It only talks to the Lynx API (net.lynxclient.api.*). That API is the same on every Minecraft version, so one jar runs everywhere LynxClient runs.
• LynxClient's own features are built on exactly this API. Everything you see in the mod menu (switches, sliders, the HUD editor, translations) works the same for your addon.

public final class MyAddon implements LynxAddon {
    @Override
    public void onLoad(LynxApi lynx) {
        lynx.modules().register(new HelloWidget());
    }
}

What the API gives you

Area	What you get
Modules	A feature with an on/off switch, a hotkey and settings
Settings	Annotated fields: menu page, saving and search for free
HUD widgets	Text or freely drawn widgets the player places in the HUD editor
Events	Client ticks, key and mouse presses (cancellable), your own events
Game info	FPS, position, ping, pressed keys, armour, potion effects …
Translations	German and English texts from your jar

What addons cannot do

Addons do not get Minecraft classes, mixins or access to the player's login. This keeps them version-independent and is a rule of the store. If you need something the API does not offer yet, tell us. The API grows with what addons need.

Where addons come from

Players install addons from the store, in the launcher (Addons tab) or in game (mod menu → Addons). LynxClient only loads addons that were reviewed and signed by us. While developing, you can load your own unsigned builds, see Getting started.