Skip to content

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 buttonEffect
Show retired / Hide retiredRetired plugins are hidden by default.
Check for updatesAsks uMod for new versions of every plugin; see Approvals.
Upload releaseUploads a .cs file as an approved release.

List view ​

ColumnContent
PluginDisplay name (opens the detail page) and file name.
KeyThe plugin class name, its identity.
Originplatform or tenant (a legacy plugin a community uploaded).
Latest approvedVersion and short SHA, or "none approved".
ServersNumber of servers it is installed on.
CatalogListed, Unlisted, Draft or Rejected.
Statusretired, update pending (a newer upstream version or servers on an older release; the tooltip says how many) or up to date.
ActionsRetire / 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 ​

  1. Click Upload release and choose a .cs file (at most 3 MB; the file name uses letters, digits, _ or -).
  2. The plugin key is the class name in the file. A new key creates a new plugin; an existing key adds a new version.
  3. 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 ​

ActionEffect
RetireHides the plugin from the catalog and the install picker; no new installs. "N existing install(s) keep running." Restore brings it back.
DeleteDeletes 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 ​

PartContent
HeaderName, origin, key, and (for plugins with a uMod source) "uMod checked time" and the next scheduled check, with Check uMod.
Catalog listingThe editor below (platform plugins).
RolloutPolicy and rollouts: Rollouts.
Release historyVersion, SHA, origin, status, approved by and date; the latest is marked latest. A paper icon marks a release with a changelog.
SourceClick 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.

FieldDetail
ApprovalDraft, Approved, Rejected.
Listed in the community catalogSwitch. Needs Approved to take effect.
Review noteWhy it was approved or rejected, up to 500 characters, staff only.
Title, AuthorOverride the values read from the file (up to 100 characters).
Short descriptionOne sentence for the card, up to 280 characters.
CategoryAdmin, Chat, Economy, Events, Gameplay, Kits, Library, Loot, Moderation, PvP, Quality of life, RustyThrones, Utility.
TagsComma separated.
Website (uMod / Codefling), Icon URLLinks; the icon must be https.
Long description, Configuration notesMarkdown (HTML is stripped).
RequiresHard dependencies, each with an optional minimum version; installed together with the plugin.
Works withOptional integrations with a note.
Conflicts withPlugins that must not run together, with the reason.
Commands, PermissionsPrefilled from the source; edit or add chat and console commands and permissions.
Changelog ofPick a release and write its changelog in Markdown.

Click Save listing (or Discard). The bar "Unsaved listing changes" shows while there are edits.

Troubleshooting ​

ProblemFix
Delete button disabledThe plugin is installed on servers: "remove those installs first".
Upload refusedThe file is not .cs, is over 3 MB, or has no valid plugin class.
Plugin not visible to communitiesSet Approval to Approved and switch Listed on.