From b11ed535633b7353e970afa2cc48420dd5d6881b Mon Sep 17 00:00:00 2001 From: krypek Date: Tue, 9 Jul 2024 13:19:10 +0200 Subject: [PATCH 1/2] Update the tutorial to use ccmod.json instead of package.json --- makingAMod.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/makingAMod.md b/makingAMod.md index 7706335..25ec526 100644 --- a/makingAMod.md +++ b/makingAMod.md @@ -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/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 @@ -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") \ No newline at end of file +![Recolor result](./images/leaRecolored.png "Recolor resultt") From 0c1e784f0ce900e3a17f0123969ce8cd1718e4c4 Mon Sep 17 00:00:00 2001 From: krypek Date: Thu, 19 Sep 2024 17:05:45 +0200 Subject: [PATCH 2/2] Fix ccmod standard link --- makingAMod.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/makingAMod.md b/makingAMod.md index 25ec526..a1de7ec 100644 --- a/makingAMod.md +++ b/makingAMod.md @@ -14,7 +14,7 @@ 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/CCMOD-STANDARD.md) to learn how to create your own `ccmod.json`. +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 @@ -36,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 resultt") +![Recolor result](./images/leaRecolored.png "Recolor result")