AZ-MODS Docs¶
Build, test and publish mods for the XDJ-AZ.
Getting startedWhat a mod is, how it runs, what you need
Set up your environmentmacOS, Windows and Linux, with one build command
Your first modThe template step by step: init, tick and a settings page
Testing on your deckThe test harness, SSH, installing, logs and crash recovery
Hooks and firmware tagsChanging EP147's own code on a specific firmware build
Packaging and publishingGitHub releases that users add by repository, and the optional Mod Index
GuidelinesThe crash-safety rules, good habits and a checklist before publishing
API referenceEvery service with its thread and its limits
The Guidelines cover what keeps a mod stable.
Repositories¶
| Repository | What it is |
|---|---|
| xdj-az-mods | AZ-MODS itself: releases, issues and the source, including the core that loads mods |
| xdj-az-emu | The XDJ-AZ emulator: the deck's program on your computer, for building and testing mods |
| az-mods-sdk | The SDK: the azmod-mod.h header, the build container, the template mod, the azmod-pack tool, and this guide's source |
| az-mods-examples | Example mods covering the services, with their test scenarios |
| az-mods-index | The Mod Index: repositories every deck shows by default, an optional route for publishing |
The SDK and every mod are GPL-3.0, and mods are published with their source (see License).