Creating a new mod

To start creating a mod, go to [Assets > Mods > Create New Mod].

Fill in the details and click "Create Mod". Note that some fields have restrictions on what you can/must enter.

• ID
  • May only contain lowercase letters, numbers, underscores ("_"), and periods (".").
  • Must start with a letter.
  • Cannot end with an underscore or period.
  • Cannot end with "modscenes" or "modscenedata" for technical reasons.
  • Cannot be empty.
• Title
  • Cannot be empty.
• Author
  • Cannot be empty.
• Version
  • May only contain lowercase letters, numbers, underscores, and periods.
  • Cannot start or end with underscores or periods.
  • Cannot contain two non-letters/numbers one after the other; so no "..", "__", "._", or "_.".
  • Cannot be empty.

Assuming no errors occurred, a new folder will be created in the root "Assets" directory with the given name. From here on, this folder will be referred to as your [Mod folder]. Inside this folder will be three other folders, "Mod", "Scenes", and "SceneData".

"Mod" is where the majority of your mod content should go. Things like cars, skins, music, etc. go here.

"Scenes" should only contain all scenes (ex. worlds) that your mod contains.

"SceneData" is for any asset that a scene relies on, such as textures or materials. These assets stay loaded so that scenes load properly. Only include assets that your scenes need to reduce the strain your mod places on the game and the computers running it.

Dependencies

Mods can also depend on other mods. This is because it is possible for a mod to add content to other mods. This can be done by selecting the asset at [Mod folder/Mod/mod.asset] and modifying the dependency list.

To add a dependency, click the "+" button.

Fill out the ID and version of the mod that yours depends on.

[!Warning] The dependency list is not checked for errors in the mod creator. However, if the game detects an error, it will not load your mod.

For that reason, here are some guidelines:

• ID: should be a valid mod ID. If a mod with this exact ID is not present, your mod will not load because it doesn't have its dependencies met.
• Version
  • An "*" can be used only at the end to determine any version that matches the first part.
    • "0.1.*" will match "0.1.0", "0.1.a", etc.
    • "*" by itself will match any version.
  • Don't use multiple "*".

[!WARNING] Using "*" to match any version can be dangerous. This is because some version of a mod may not contain the assets that your mod relies on, which could cause your mod to encounter an error.

The following pages in this wiki go in-depth on how each asset you want can be created and modified to your liking.