Appearance
Plugin catalog
Platform plugins is the catalog of every plugin: what exists, which releases are approved, how it is listed to communities and on how many servers it runs. Capability: operations. For the principles, read Plugin governance.
The list
The header shows the number of plugins. Two views switch with List and Catalog (your choice is remembered in the browser). A search box matches the name, key, file name, title, summary, author and tags; in the Catalog view a category row filters (All plus the categories).
| Header button | Effect |
|---|---|
| Show retired / Hide retired | Retired plugins are hidden by default. |
| Check for updates | Asks uMod for new versions of every plugin; see Approvals. |
| Upload release | Uploads a .cs file as an approved release. |
List view
| Column | Content |
|---|---|
| Plugin | Display name (opens the detail page) and file name. |
| Key | The plugin class name, its identity. |
| Origin | platform or tenant (a legacy plugin a community uploaded). |
| Latest approved | Version and short SHA, or "none approved". |
| Servers | Number of servers it is installed on. |
| Catalog | Listed, Unlisted, Draft or Rejected. |
| Status | retired, update pending (a newer upstream version or servers on an older release; the tooltip says how many) or up to date. |
| Actions | Retire / Restore, Delete. |
Catalog view
Cards like the ones communities see, with the same chips (community for tenant plugins, retired, update, server count). Click a card for the detail page.
Upload a release
- Click Upload release and choose a
.csfile (at most 3 MB; the file name uses letters, digits,_or-). - The plugin key is the class name in the file. A new key creates a new plugin; an existing key adds a new version.
- The release is approved immediately and becomes the latest. The result line says one of:
- "file: vX already in the catalog (approved)." when the same file exists;
- "uploaded as the latest approved release - rollout started" when the plugin's policy is auto;
- "uploaded as the latest approved release - use Roll out on the plugin to deploy it" when the policy is manual.
Uploading changes the catalog only. A server changes when a rollout reaches it or a community picks the version.
Retire and delete
| Action | Effect |
|---|---|
| Retire | Hides the plugin from the catalog and the install picker; no new installs. "N existing install(s) keep running." Restore brings it back. |
| Delete | Deletes the plugin and all its releases for good (and its finished rollouts). Refused while any server has it installed: remove those installs first. |
Prefer retiring.
The plugin page
| Part | Content |
|---|---|
| Header | Name, origin, key, and (for plugins with a uMod source) "uMod checked time" and the next scheduled check, with Check uMod. |
| Catalog listing | The editor below (platform plugins). |
| Rollout | Policy and rollouts: Rollouts. |
| Release history | Version, SHA, origin, status, approved by and date; the latest is marked latest. A paper icon marks a release with a changelog. |
| Source | Click a release to read its source with a diff against the previous release. |
Catalog listing editor
A banner says "Communities can install it", "Approved, not listed (dependency only)" or "Hidden from communities". Preview card shows what communities will see.
| Field | Detail |
|---|---|
| Approval | Draft, Approved, Rejected. |
| Listed in the community catalog | Switch. Needs Approved to take effect. |
| Review note | Why it was approved or rejected, up to 500 characters, staff only. |
| Title, Author | Override the values read from the file (up to 100 characters). |
| Short description | One sentence for the card, up to 280 characters. |
| Category | Admin, Chat, Economy, Events, Gameplay, Kits, Library, Loot, Moderation, PvP, Quality of life, RustyThrones, Utility. |
| Tags | Comma separated. |
| Website (uMod / Codefling), Icon URL | Links; the icon must be https. |
| Long description, Configuration notes | Markdown (HTML is stripped). |
| Requires | Hard dependencies, each with an optional minimum version; installed together with the plugin. |
| Works with | Optional integrations with a note. |
| Conflicts with | Plugins that must not run together, with the reason. |
| Commands, Permissions | Prefilled from the source; edit or add chat and console commands and permissions. |
| Changelog of | Pick a release and write its changelog in Markdown. |
Click Save listing (or Discard). The bar "Unsaved listing changes" shows while there are edits.
Troubleshooting
| Problem | Fix |
|---|---|
| Delete button disabled | The plugin is installed on servers: "remove those installs first". |
| Upload refused | The file is not .cs, is over 3 MB, or has no valid plugin class. |
| Plugin not visible to communities | Set Approval to Approved and switch Listed on. |