Publishing Your Mod

This guide covers packaging a Voxel Playground mod and uploading it to mod.io.

Prerequisites

Before publishing:

1. Create a mod.io account.
2. Join the Voxel Playground game page on mod.io.
3. Verify the mod locally with the workflow in Test Mod.

Step 1: Prepare the build

1. Confirm every shipped prefab is listed in manifest.asset.
2. Run the TypeScript lint step for the mod.
3. Build the release from Vox Mod Tools > Mod Exporter.

Use the exporter output as the package you upload to mod.io.

Step 2: Create the mod profile

1. Sign in to mod.io.
2. Open the Voxel Playground game page.
3. Click Add Mod.
4. Fill in the listing details:
   • Name
   • Summary
   • Logo / thumbnail
   • Description
   • Tags

Step 3: Upload a build

1. Open your mod page on mod.io.
2. Go to Files.
3. Upload the package generated by the exporter.
4. Set the matching version number.
5. Mark the uploaded file as the live release when ready.

Updating a mod

For each update:

1. Increment the version in your mod metadata.
2. Rebuild from the exporter.
3. Upload the new build on mod.io.
4. Keep your mod.io changelog aligned with the in-toolkit version.

Release checklist

• Test the exact exported build.
• Make sure prefab references and JsProperties bindings are not missing.
• Remove debug-only logging if it is no longer useful.
• Include clear installation and usage notes on the mod.io page.