Skip to content
Runesmith Hub

Runesmith Hub

Publishing guide

Register a plugin

This form generates your registration files and opens GitHub's new-file page in the registry with them filled in. Read Registering first.

Publisher

The first part of your plugin IDs, such as lumen.

Shown on your plugins, such as Lumen Labs.

The user or organization that owns the repository.

Owner type

The permanent number GitHub gives the account. Look it up (the id field).

Plugin

The second part of the ID, such as todo.

Public, on GitHub, with plugin.json on its default branch.

Look it up (the id field).

Where plugin.json is. Use . for the repository root.

Maintainers

GitHub accounts that may act for the plugin. Each needs write access to the repository.

Plugin ID

publisher.name

Starts unverified. IDs are never reused.

Publisher record

publishers/.json
{
  "name": "",
  "displayName": "",
  "owner": {
    "id": 0,
    "login": "",
    "type": "Organization"
  },
  "state": "active"
}
Open on GitHub

Registration for .

plugins/./registration.json
{
  "id": ".",
  "repository": {
    "id": 0,
    "url": "",
    "path": ".",
    "tagPrefix": "v"
  },
  "maintainers": [
    {
      "id": 0,
      "login": ""
    }
  ],
  "tier": "unverified",
  "state": "registered",
  "registeredAt": ""
}
Open on GitHub

This page only builds links; nothing is sent anywhere. On GitHub, commit each file to one new branch and open a single pull request. The registration check runs on it, and an administrator looks at the name, icon, repository and README.