Modding Wiki
  • 🏠Home
  • 🫂How to contribute
  • Playing with Mods
    • Discovering Mods
    • Installing Mods
      • On Game Clients
      • For Multiplayer
      • On Dedicated Servers
      • No Console Support
    • Troubleshooting
    • Reporting Bugs
    • Uninstalling Mods
  • Creating Mods
    • Getting Started Modding
      • Setting Up the Modding SDK
      • Testing the Example Mods
      • Viewing Console Logs
    • Modding Limitations
    • Inspecting Other Mods' Code
    • Modding Tools
      • Scripting IDE
      • Unity Explorer
      • Asset Ripper
      • NG Tools Missing Script Recovery
      • DnSpy
      • Attaching a Debugger
    • Common Concepts
      • Unique Names and IDs
    • Modding Libraries
      • CoreLib
    • Modding Examples
      • Items
        • Weapons and Tools
        • Armor
        • Food
      • Obtaining items
        • Adding Crafting Recipe
        • Adding your items to crafters
        • Adding items to Enemy loot
      • Placeables
        • Tiles
      • NPCs and Enemies
      • UI and Interactions
      • Client-Server communications
    • Inspecting Base Game Content
      • Importing Ripped Assets to your Editor
      • Inspecting Assets In-Game
      • Inspecting Game Code
    • Updating your Modding SDK
    • Releasing Mods
      • Create a mod.io Page
      • Mod Files Upload
  • Concepts
    • Important Folder Paths
    • Technologies and Tools
    • Elevated Access
  • Archive
    • General Reference
    • Outdated Unity Setup Guide
    • Outdated IL2CPP Guides
      • Getting started with modding
      • How to view game source code
      • How to setup your Unity project
      • How to install Core Keeper mono version
Powered by GitBook
On this page
  • Read the mod.io Guidelines
  • Write a Description
  • Apply Tags
  • Game Version
  • Type
  • Application Type
  • Access Type
  • Dependencies

Was this helpful?

Edit on GitHub
Export as PDF
  1. Creating Mods
  2. Releasing Mods

Create a mod.io Page

PreviousReleasing ModsNextMod Files Upload

Last updated 8 months ago

Was this helpful?

You should have already created a mod.io account as part of . Now it's time to create a page for your mod. This is what end users will see when they are looking at your mod for the first time, so make it professional if you want to leave a good impression.

Read the mod.io Guidelines

Make sure that your mod complies with the guidelines described here:

Write a Description

Here is the bare minimum information you should describe in your mod page description:

  • Directions on how to access and configure your mod's features.

    • What crafting bench are the items made in?

    • Where do you configure keybinds, and what are the defaults?

  • How users should report bugs

    • A GitHub issue tracker? Contact you on discord? The mod.io comments section?

  • If the mod is required by all users in multiplayer, just the client, or just the server

Here is other stuff to consider including:

  • Screenshots of the mod in action. People like pictures!

  • Known bugs (or a link to a bug tracker)

  • Link to mod source repository (ex. GitHub)

  • "Special Thanks" to list other people that helped your mod come to be

Apply Tags

Tags help categorize your mod and assist users with finding it. Some tags also have special functionality.

Game Version

Use the "Game Version" tags to indicate what versions your mod supports. If a user doesn't see the latest game version tag on your mod, they might think it's broken, and the game may report the mod as out of date to the user.

Type

Use the "Type" tags as categories for summarizing what kinds of content your mod adds and changes it makes. You can select as many or as few as you want.

Application Type

Tag Combination
Purpose

Client

Mod must be installed on game clients to function correctly.

Server

Mod must be installed on host-and-play servers and dedicated servers to function correctly.

Client, Server

Mod must be installed for on all sides to function correctly.

(No Application Type tags)

Don't do this, it makes it unclear where the mod should be installed.

Access Type

"Access Type" tags control mod loading behavior. Only one should be selected at a time.

Tag Combination
Purpose

(No Access Type tags)

Legacy compatibility behavior - does the same thing as the Script tag. Don't do this.

Asset

No mod scripts will be loaded.

Script

Mod scripts will be loaded. Most mods involve some scripts; this is the most commonly used option.

Script (Elevated Access)

Dependencies

List any other mods or libraries that your mod depends on. The Mod SDK upload utility might have automatically filled this out for you.

Use tags "Application Type" to help users understand where the mod needs to be installed in .

Loads mod scripts in mode.

multiplayer
Elevated Access
setting up the Modding SDK
LogoCore Keeper Mod.io User Guidelines guide for Core Keeper - mod.iomod.io