Getting Started

Secure Mods. Seamless Installs.

Steps to Publish Your First Mod

Create your developer account, configure your local workspace, and deploy to ModVault in under ten minutes.

1. Register a Developer Account

Visit developers.modvault.io/signup and verify your email. Enable two-factor authentication during onboarding to secure your API keys. You will receive a default workspace named sandbox-01.

2. Initialize Your Workspace

Install the ModVault CLI with npm i -g @modvault/cli and run mv auth to link your account. Create a new project directory with mv init my-first-mod to generate the required configuration files.

3. Publish and Distribute

Run mv build --prod to compile your assets, then mv publish --version 1.0.0. Your mod will be scanned, versioned, and live on the registry within sixty seconds.

Create Developer Account Read CLI Documentation

Required File Structure

ModVault enforces a strict directory layout to guarantee compatibility across all supported engines. Follow this template before your first build.

Project Root

my-first-mod/
├── modvault.json        # Metadata, dependencies, and entry points
├── src/
│   ├── index.js         # Main execution script
│   ├── config.yaml      # Runtime settings
│   └── assets/          # Textures, models, and audio
├── tests/               # Automated validation suite
└── README.md            # Licensing and usage instructions

The modvault.json manifest must include name, version, engine, and entryPoint fields. Missing or malformed manifests will fail the automated integrity check during mv publish.

Example Manifest

{
  "name": "@user/my-first-mod",
  "version": "1.0.0",
  "engine": "unity-2022.3",
  "entryPoint": "./src/index.js",
  "dependencies": {
    "@modvault/core": "^4.2.0"
  }
}

Keep asset bundles under 25 MB for faster CDN delivery. Use the mv optimize command to compress textures and strip debug symbols before publishing.