makingAMod.md

Making a mod

Requirements

• Installing CCLoader
• Finding the CrossCode installation folder

Steps

1. Open the CrossCode installation folder
2. Open assets -> mods
3. Create a new folder for your mod. In this example we are going to use myMod
4. Create a new file called package.json

This file is used to tell CCLoader how to load your mod. It contains the internal name (name) the displayed name (ccmodHumanName), versions (version) and dependencies (ccmodDependencies). Only name and version are required.

Example package.json

{
    "name": "my-mod",
    "ccmodHumanName": "My Mod",
    "version": "1.0.0"
}

5. Find a file to modify

In this example we will do a simple palette swap of Lea. You can find her sprites in assets/media/entity/player/move.png.

6. Copy the file to your mod

In order for CCLoader to pick up the file from the mod it needs to be inside the mod folder with the same name as the original. This means that assets/media/entity/player/move.png turns into assets/mods/myMod/assets/media/entity/player/move.png.

⚠️ Do not publish original CrossCode files in your mod

7. Edit the file

In this example I am using Paint.net to swap Lea's red clothes for green ones:

8. Restart the game and test your mod