Submit Your Mod to the Registry

Adding your mod to the registry is easy! Follow these steps:

Prerequisites

• Your mod must be hosted on GitHub (or another git host)
• You need a GitHub account

Quick Submission

No fork or pull request of your own is needed.

1. Fill in the Manifest Generator.
2. Click Submit, next to Copy. A new tab opens the registry-index issue form on GitHub with your manifest already filled in. Sign in if asked.
3. Click Create. The issue is public. A bot validates the manifest and its URLs, then opens a pull request that closes the issue.
4. Maintainers review and merge the pull request. The mod appears on the site after the next site build.

If validation fails, the bot comments on the issue with the errors. Edit the issue's manifest to fix them; the bot retries on every edit.

If the manifest is too long for the link, the issue form opens empty. Click Copy and paste the manifest into the Manifest field.

The steps below are for opening the pull request yourself.

Step 1: Fork registry-index

1. Go to github.com/cataclysmbn/registry-index
2. Click "Fork" to create your own copy

Step 2: Create a Manifest File

You can create a manifest file in one of three ways:

Option A: Web Generator (Recommended)

Use the Manifest Generator to create your manifest file interactively. It can automatically fetch mod information from your GitHub repository.

Option B: CLI Fetch Command

If you prefer working from the command line, clone the tooling repo and write output to your registry-index fork:

git clone https://github.com/cataclysmbn/registry.git
git clone https://github.com/YOUR_USERNAME/registry-index.git
cd registry

deno task fetch https://github.com/yourname/your-mod -o ../registry-index/manifests

# Or use the shorthand format
deno task fetch yourname/your-mod -o ../registry-index/manifests

The CLI will:

1. Scan the repository for modinfo.json files
2. Let you select which mods to generate registry-index/manifests for
3. Create/update YAML manifest files in the registry-index/manifests/ folder
4. Automatically detect parent mods for patchmods

Fetch Options:

Example: Fetch all mods from a repository:

deno task fetch --all https://github.com/Chaosvolt/Cataclysm-BN-Modular-Mods

Example: Filter for a specific mod:

deno task fetch --filter "arcana" https://github.com/Chaosvolt/Cataclysm-BN-Modular-Mods

Option C: Manual Creation

Create a new YAML file in your registry-index/manifests/ folder named after your mod ID:

# registry-index/manifests/your_mod_id.yaml
schema_version: "1.0"

id: your_mod_id
display_name: "Your Mod Name"
short_description: "A brief description of your mod (max 200 chars)"

author: "Your Name"
license: "MIT" # Use SPDX identifier
homepage: "https://github.com/yourname/your-mod"

version: "1.0.0"

dependencies:
  - bn: ">=0.9.1"

categories:
  - content

source:
  type: github_archive
  url: "https://github.com/yourname/your-mod/archive/refs/tags/v1.0.0.zip"

Step 3: Validate Your Manifest

Run the validation tool to check your manifest:

deno task validate registry-index/manifests/your_mod_id.yaml
deno task check-urls registry-index/manifests/your_mod_id.yaml

Step 4: Submit a Pull Request

1. Commit your manifest file in your registry-index fork
2. Push to your fork
3. Open a pull request to cataclysmbn/registry-index

Manifest Fields Reference

Required Fields

Optional Fields

Modpack Extraction

If your mod is part of a larger modpack, use extract_path:

source:
  type: github_archive
  url: "https://github.com/user/modpack/archive/abc123.zip"
  extract_path: "modpack-abc123/Mods/YourMod"

Auto-Updates

To enable automatic version updates:

autoupdate:
  type: tag # or "commit"
  url: "https://github.com/user/repo/archive/$version.zip"