# Myriad

> Myriad is a free, open-source, addon-first utility client for Minecraft 26.2 on Fabric. Its menu is a tiling window
> manager; every module comes from an addon built on its public Java API (dev.myriadclient.api). These docs cover using
> Myriad and writing addons: modules, settings, events, services, the menu, rendering, hooks, shared configs.

Each page below is plain Markdown. https://myriadclient.dev/llms-full.txt has every page in one file. For writing an addon, read
"For AI agents" first: it has the rules an addon must follow.

## Myriad docs

- [Myriad docs](https://myriadclient.dev/docs.md): How to use Myriad, the addon-first Minecraft utility client, and how to build addons for it.

## Using Myriad

- [Getting started](https://myriadclient.dev/docs/use.md): Install Myriad, open the menu, and turn on your first module.
- [The menu](https://myriadclient.dev/docs/use/menu.md): Workspaces, windows, layouts and the keys that drive Myriad's tiling menu.
- [The launcher](https://myriadclient.dev/docs/use/launcher.md): Find and run anything in Myriad from the keyboard, with @addon and #kind filters.
- [Modules and settings](https://myriadclient.dev/docs/use/modules.md): Turning modules on and off, binding keys, hold mode, and the kinds of settings modules have.
- [Control panels](https://myriadclient.dev/docs/use/control-panels.md): Turn a set of modules on together with one key, each with settings just for that job.
- [Setting layers](https://myriadclient.dev/docs/use/setting-layers.md): How control panels and modules can set a setting for a while without changing yours.
- [Macros](https://myriadclient.dev/docs/use/macros.md): Modules you make that run commands, chat or server commands on a key.
- [Sharing your config](https://myriadclient.dev/docs/use/sharing.md): Share modules, control panels and your theme as a short code, view shares on the website, and take one in.
- [Themes](https://myriadclient.dev/docs/use/themes.md): Change how the menu looks, make your own themes, and Myriad's preferences.
- [The HUD](https://myriadclient.dev/docs/use/hud.md): Arrange what's drawn over the game: coordinates, the module list, armour and more.
- [Profiles](https://myriadclient.dev/docs/use/profiles.md): Keep separate setups per server or play style, and where Myriad keeps its files.
- [Anti-cheat profile](https://myriadclient.dev/docs/use/anti-cheat.md): How Myriad's modules adapt to servers running Grim (like 2b2t) or only vanilla checks.
- [What addons changed](https://myriadclient.dev/docs/use/hooks.md): See which addons change how Myriad itself works, and turn any of it off.
- [Addons and updates](https://myriadclient.dev/docs/use/addons.md): Install addons, keep them up to date, and what happens when one fails.
- [Commands](https://myriadclient.dev/docs/use/commands.md): Every chat command Myriad has, from toggling modules to sharing configs.
- [Essentials](https://myriadclient.dev/docs/use/essentials.md): The stock modules that come with Myriad Essentials.
- [Questions](https://myriadclient.dev/docs/use/faq.md): Common questions and fixes.

## Developers

- [Developers](https://myriadclient.dev/docs/develop.md): Build addons for Myriad. What an addon is, what the API gives you, and a complete first addon.
- [Setting up](https://myriadclient.dev/docs/develop/setup.md): Create an addon project from the template, run the dev client, and build your jar.
- [The addon and its context](https://myriadclient.dev/docs/develop/addon.md): MyriadAddon's phases and everything AddonContext registers.
- [Modules](https://myriadclient.dev/docs/develop/modules.md): Writing modules: lifecycle, events while enabled, HUD info, conflicts, renaming and migrating settings.
- [Settings](https://myriadclient.dev/docs/develop/settings.md): Every setting type, the builder, groups, visibility, private settings, layered overrides and custom types.
- [Events](https://myriadclient.dev/docs/develop/events.md): The event bus, @Subscribe options, priorities, cancelling, and every core event.
- [Commands](https://myriadclient.dev/docs/develop/commands.md): Chat commands with Brigadier, Myriad's argument types, and replying.
- [Windows, HUD and widgets](https://myriadclient.dev/docs/develop/ui.md): Panels for the menu, HUD elements, the widget toolkit, title-bar controls, bar widgets and themes.
- [Drawing in the world](https://myriadclient.dev/docs/develop/rendering.md): Immediate shapes, GPU meshes, per-chunk caches, shader highlights with custom fills, and labels.
- [Services](https://myriadclient.dev/docs/develop/services.md): Rotations, inventory, placement, breaking, building, containers, tasks, the packet budget, anti-cheat and elytra flight.
- [Hooks](https://myriadclient.dev/docs/develop/hooks.md): Change how Myriad (or another addon) works: replace a whole service, or handle one decision, for everyone, your own modules, or one server.
- [Control panel presets](https://myriadclient.dev/docs/develop/control-panels.md): Ship ready-made control panels with your addon, with typed settings for your own modules.
- [Shared configs](https://myriadclient.dev/docs/develop/sharing.md): Keep private settings out of shares with protect(), and build, publish and apply shares from code.
- [Storage and config](https://myriadclient.dev/docs/develop/storage.md): Your addon's own files, versioned data that upgrades itself, and how Myriad saves profiles.
- [Compatibility and versions](https://myriadclient.dev/docs/develop/compatibility.md): The API contract, versioning, supporting several Myriad versions, optional integrations and mixins into other mods.
- [Performance](https://myriadclient.dev/docs/develop/performance.md): Keep your addon cheap: work per tick, draw per frame, cache per chunk, and measure with the Profiler.
- [Testing](https://myriadclient.dev/docs/develop/testing.md): The dev client, the scripted dev console, selftest, fake players, and checking against Grim.
- [Publishing](https://myriadclient.dev/docs/develop/publishing.md): Release your addon on GitHub so Myriad can update it, with an icon and the right fabric.mod.json.
- [Building on Essentials](https://myriadclient.dev/docs/develop/essentials.md): Essentials' hooks, its modules' ids, and how to change its behaviour from your addon without depending on it.
- [For AI agents](https://myriadclient.dev/docs/develop/agents.md): How an AI agent should read these docs and the rules it must follow to write a correct Myriad addon.
- [API reference map](https://myriadclient.dev/docs/develop/reference.md): Where everything is in the dev.myriadclient.api packages.