Publish a plugin

Listing is free and runs through GitHub. There’s no account to make: you open one pull request, and after that every GitHub release you sign reaches HikariSub by itself.

  1. Write the plugin

    Follow the plugin authoring guide on hikarisub.org. Its id starts with your GitHub handle: mirai.karaoke-flow.

  2. Make a signing key

    Keep the secret key to yourself. We pin the public key to your handle, and a new key goes through us.

    minisign -G -p mirai.pub -s ~/.minisign/mirai.key
  3. Open a listing pull request

    Add one file to altqx/hikari-plugins. We review the first listing by hand, usually within a week.

    plugins/mirai.karaoke-flow.json
    {
      "id": "mirai.karaoke-flow",
      "author": "mirai",
      "repo": "github.com/mirai/karaoke-flow",
      "publicKey": "RWQf6LRCGA9i53ml…",
      "categories": ["Karaoke"]
    }
  4. Publish a GitHub release

    Attach the package and its signature. Our checks pick it up within half an hour and it appears here once they pass.

    karaoke-flow/releases/v2.3.1
      mirai.karaoke-flow-2.3.1.hikariplugin
      mirai.karaoke-flow-2.3.1.hikariplugin.minisig
  5. Updates

    Every later release goes through the same checks: the manifest, the API number, the size, the file paths and your signature.

    A release that asks for more than the last one (a new host, a folder, every open document, or the unrestricted tier) waits for our review. Users are asked before it installs.