Skip to content

Update the tutorial to use ccmod.json instead of package.json #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update the tutorial to use ccmod.json instead of package.json #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b11ed53
Update the tutorial to use ccmod.json instead of package.json
krypciak Jul 9, 2024
0c1e784
Fix ccmod standard link
krypciak Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions makingAMod.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,12 @@
1. Open [the CrossCode installation folder](./findingCrossCode.md)
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`
4. Create a new file called `ccmod.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`
```json
{
"name": "my-mod",
"ccmodHumanName": "My Mod",
"version": "1.0.0"
}
```
This file is used to tell CCLoader how to load your mod.
It contains information about the mod title, version, description, etc...
Read [the `ccmod.json` standard](https://github.com/CCDirectLink/CCModDB/blob/master/docs/CCMOD-STANDARD.md) to learn how to create your own `ccmod.json`.
Only `id` and `version` are required to just load the mod, but if if you want to publish it to the centralized mod database, you need to follow the standard mentioned above.

5. Find a file to modify

Expand All @@ -42,4 +36,4 @@ 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

![Recolor result](./images/leaRecolored.png "Recolor result")
![Recolor result](./images/leaRecolored.png "Recolor result")