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 to submit pull requests

Step 1: Fork the Registry

Go to github.com/cataclysmbn/registry
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 registry and use the fetch command:

# Clone your fork
git clone https://github.com/YOUR_USERNAME/registry.git
cd registry

# Fetch mods from a GitHub repository
deno task fetch https://github.com/yourname/your-mod

# Or use the shorthand format
deno task fetch yourname/your-mod

The CLI will:

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

Fetch Options:

Option	Description
`-o, --output <dir>`	Output directory (default: `registry-index/manifests`)
`-a, --all`	Generate all mods without prompting
`--filter <pattern>`	Filter mods by path (regex)
`--exclude <pattern>`	Exclude mods by path (regex)
`--dry-run`	Preview without writing files

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 the 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

Commit your manifest file
Push to your fork
Open a pull request to the main repository

Manifest Fields Reference

Required Fields

Field	Description
`schema_version`	Always `"1.0"`
`id`	Unique identifier (lowercase, underscores)
`display_name`	Human-readable name
`short_description`	Brief description (max 200 chars)
`author`	Mod author(s)
`license`	SPDX license ID or `"ALL-RIGHTS-RESERVED"`
`version`	Current version
`source.type`	`"github_archive"`, `"gitlab_archive"`, or `"direct_url"`
`source.url`	Direct download URL for the mod archive

Optional Fields

Field	Description
`description`	Full mod description
`homepage`	Link to repo or documentation
`dependencies`	List of required mod IDs
`conflicts`	List of incompatible mod IDs
`categories`	Organization categories
`tags`	Search tags
`icon_url`	Icon URL (`.png`, `.svg`, `.webp`, `.avif`, `.jpg/.jpeg`, `.gif`)
`source.extract_path`	Path inside archive for modpacks
`source.commit_sha`	Git commit SHA for verification

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"