Create your addons
Build custom jobs, weapons, vehicles and more in the s&box editor — then ship them to any Emrald server.
An addon is an s&box package that extends a gamemode running on Emrald. Addons can add new jobs, weapons, vehicles, NPCs, entities, UIs, or any other system the base gamemode exposes a hook for.
Addons live in the s&box editor like any normal s&box project, but with two extras:
- You declare the variables and permissions your addon needs so Emrald can show them in operators' panels.
- You register the addon on Emrald (
/me/addons) so operators can install it on their projects.
Two distribution models
| Model | Visibility | Install flow |
|---|---|---|
| Public | Listed in emrald.xyz/addons | Operators see it in the Addon Browser and install in one click |
| Private | Hidden from the Browser | You share the ident + a security token with specific operators, who install manually |
Both use the same code on the s&box side — the visibility flag is just a panel setting on your registered addon.
Where to start
Recipes
Concrete walkthroughs for the most common addon types on a DarkRP-based project. Each one is a focused tutorial — read top to bottom, adapt to your case.
Create a job
A new role players can swap into via the F4 menu — Citizen, Cop, Hitman, Mayor, anything you want.
Create a weapon
A new weapon prefab with custom model, sounds, fire rate, damage, and view-model.
Create a vehicle
A driveable vehicle with custom handling, model, seats, and damage.
More recipes coming: Create an entity (custom money-makers, ATMs, drug labs), Create an NPC (AI-driven dialogue and combat), Create a tool (Toolgun modes). Open an issue if you'd like one prioritized.
Useful references
- s&box documentation — engine concepts, components, networking
- s&box API reference — class/method signatures
- Install addons manually — how operators install your private addon