This guide talks about how to release a mod for end users to download on mod.io.
You should have already created a mod.io account as part of setting up the Modding SDK. 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.
Make sure that your mod complies with the guidelines described here:
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
Tags help categorize your mod and assist users with finding it. Some tags also have special functionality.
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.
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.
Use tags "Application Type" to help users understand where the mod needs to be installed in multiplayer.
"Access Type" tags control mod loading behavior. Only one should be selected at a time.
List any other mods or libraries that your mod depends on. The Mod SDK upload utility might have automatically filled this out for you.
This guide has not been written yet! If you know how to do this, !
Use the Mod SDK's Upload Mod utility.
TODO: How to upload files manually so the zips don't get an awful auto-generated name?
It sounds like you can zip the file produced by the mod SDK package task yourself and upload that, just make sure it contains the mod manifest file in the root of the zip file.
| Tag Combination | Purpose |
|---|---|
| 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.
(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)
Loads mod scripts in Elevated Access mode.
