Install addons manually
Install private or unlisted addons by entering an ident and security token.
For addons that aren't listed in the public Addon Browser — typically private addons distributed directly by their creator to a specific operator — you install them manually by entering their ident and a security token.
When to use this flow
| Addon visibility | Install via |
|---|---|
| Public | Addon Browser — one click, no token |
Private (isPublic = false) | Manual install — operator needs the ident + the token shared by the addon creator |
| Unlisted but public | Either path — you can install via Browser if you find it, or manually if you have the ident directly |
A private addon stays invisible to everyone except its creator. The creator decides who can install it by sharing the ident + security token out-of-band (email, Discord, etc.).
Get the ident and token
These come from the addon creator, not from Emrald's panel. They'll typically share something like:
Ident: yourorg.private_jobs
Token: emrald_addon_xQ7zP3kRm8nWvT2hY9bC5jL4aF6sN1eUIf you're the addon's creator, you generate the token by registering the addon on your account — see Create your addons.
Treat the token like a password. Anyone with it can install your addon. If it leaks, the creator can rotate the token, which immediately invalidates every existing install — including yours, until they re-share the new one with you.
Install the addon
- Open your project → Environments → pick the env → Addons tab.
- Click Add manually.
- Fill in the dialog:
- Addon ident —
org.nameformat, lowercase, dot-separated (e.g.yourorg.private_jobs). - Security token — paste the token from the creator. The field is password-masked.
- Addon ident —
- Click Add.
Behind the scenes:
- Emrald checks the ident exists in the registry.
- If the addon is private, Emrald validates the token against the stored hash.
- On success, the addon is installed into this environment and its variables / permissions appear in the catalog.
Ident format
The ident must match <org>.<name> where each part is [a-z0-9_]+:
| Valid | Invalid |
|---|---|
yourorg.hitman | YourOrg.Hitman (uppercase) |
team42.cool_addon | team42-cool-addon (dashes not allowed) |
my_team.weapons_v2 | my.team.weapons (more than one dot) |
The panel validates the format inline and rejects bad idents before sending the request.
What happens if you skip the token
If the addon is public, the token field is optional — Emrald installs the addon without validation.
If the addon is private and you skip the token, the install is rejected with Token required for private addon.
If you're not sure which type the addon is, just paste the token anyway — it's ignored for public addons.
After install
Manual installs land in the same place as Browser installs — the env's Addons tab. You can toggle them on/off, remove them, and configure their variables / permissions normally. There's no visible difference between a Browser install and a manual install in the panel.
Token rotation
If the creator rotates the addon's token (because of a leak, or as a routine refresh), every existing install becomes invalid. Your installed addon will stop loading on the next server boot until the creator shares the new token with you and you re-install.
Symptom: the addon shows up as installed in the Addons tab, but its variables / permissions disappear from the catalog and the server-side log says Addon token invalid. Re-add the addon manually with the new token to fix.
Visibility flips
If an addon was public when you installed it and the creator later flips it to private, your existing install keeps working — Emrald doesn't store a token for installs made while the addon was public, so there's nothing to invalidate.
The reverse (private → public) doesn't affect existing installs either; they keep their stored token (now unused) until you uninstall.
Remove a manual install
Same as any addon: trash icon in the Addons tab → confirm. The addon is uninstalled from this environment along with any overrides and grants tied to it.
Next steps
- Install addons from the Browser — the simpler path for public addons
- Create your addons — register your own addon to distribute via these flows