Table of Contents

Publishing Your Mod

This guide outlines the process of publishing your mod to mod.io so other players can download and play it.

Prerequisites

Before you can publish, ensure you have:

  1. A mod.io account.
  2. Joined the Voxel Playground game page on mod.io.

Step 1: Package Your Mod

First, you need to create a distributable package of your mod.

  1. Follow the Mod Exporter Guide to build your mod.
  2. Ensure the build was successful and the output file (usually a .zip or folder) is located in Assets/Export.
  3. Verify the mod works locally by testing it (see Testing Your Mod).

Step 2: Create a Mod Profile

  1. Log in to mod.io.
  2. Navigate to the Voxel Playground game page.
  3. Click Add Mod.
  4. Fill in the required details:
    • Name: The name of your mod.
    • Summary: A brief description.
    • Logo: A 512x288 (or recommended size) thumbnail image.
    • Description: Detailed instructions and features.
    • Tags: Select appropriate tags (e.g., Weapon, Map, Character).

Step 3: Upload Mod Files

  1. Once the profile is created, go to the Files tab of your mod page.
  2. Click Add Build (or Upload File).
  3. Select the mod package you exported in Step 1 (from the Assets/Export folder).
  4. Specify the Version (e.g., 1.0.0).
  5. Mark it as the Live release.
  6. Click Upload.

Step 4: Visibility and Moderation

  • Newly uploaded mods may require approval or verification.
  • Once approved, your mod will be visible to all players in the in-game Mod Browser.

Updating Your Mod

To update an existing mod:

  1. Re-export the mod using the Mod Exporter.
  2. Go to your mod's page on mod.io.
  3. Upload the new file under the Files tab.
  4. Archive older versions if necessary.

Troubleshooting

  • Upload Failed: Check your internet connection and file size limits.
  • Mod Not Visible: Ensure the file is set to "Live" and the mod visibility is "Public".