CCDirectLink - User contributions [en]

User:Lexisother

2023-09-14T17:46:47Z

Lexisother: Add upgrade get effects

<div class="toccolours mw-collapsible mw-collapsed" style="width:400px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Ascended Gear</div><div class="mw-collapsible-content">
<syntaxhighlight lang="javascript">
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Serene Bubble+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Furious Hothead+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Trackwalker Visor+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Zealous Lamellar+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Pioneer Vest+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Reactive Plate+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Deadly Dancers+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Praetorian Anchors+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Mistwalkers+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Cerberus Fang"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Medusa Veil"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Chiron Vest"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Pegasus Greaves"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Artillery Boots+"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Speedy Boom Boots"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Highmeister Gloves"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Highmeister Gloves"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Sunshine Bracer"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Lifefiber Dress"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Meteor Trigger"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Bearseker Claw"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Bearserker Claw"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Asteroid Belt"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Moonwalkers"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Headset TYPE>:3"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Nightfeather Coat"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Singularity Drill"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Lis'mita Cap"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Enlightened Halo"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Very Last Strawhat"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Body Armoire"), 1)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Skirmisher+"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Unbreaking Fist+"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Mantis Whip+"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Golden Falcon +"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Golden Falcon+"), 2)
sc.model.player.addItem(sc.inventory.items.findIndex(i => i.name.en_US === "Brostick of Force+"), 2)
</syntaxhighlight>
</div></div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:400px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Funny effects</div><div class="mw-collapsible-content">
<syntaxhighlight lang="javascript">
ig.game.events.callEvent(new ig.Event({
steps: [
{
type: "SHOW_EFFECT",
entity: { player: true },
duration: 1,
align: "BOTTOM",
rotateFace: 0,
flipLeftFace: false,
wait: false,
waitSkip: 0,
actionDetached: false,
group: "charge",
fixPos: false,
effect: { sheet: "scene.upgrade", name: "charge" },
offset: { x: 0, y: 0, z: 0 }
},
{
type: "WAIT",
time: 4
},
{
type: "SHOW_EFFECT",
entity: { player: true },
duration: 1,
align: "BOTTOM",
rotateFace: 0,
flipLeftFace: false,
wait: false,
waitSkip: 0,
actionDetached: false,
group: "charge",
fixPos: false,
effect: { sheet: "scene.upgrade", name: "chargeBlow" },
offset: { x: 0, y: 0, z: 0 }
}
]
}), ig.EventRunType.INTERRUPTABLE);
</syntaxhighlight>
</div></div>

User:Lexisother

2023-07-10T17:43:20Z

Lexisother: Add the ascended gear giving code

Main Page

2023-07-05T11:28:44Z

Lexisother: Link to some important articles

Welcome to the CCDirectLink wiki.

This wiki contains information and a documentation about modding [https://cross-code.com CrossCode].

You probably want to start off with installing our modloader, [[CCLoader]]. Instructions can be found [[CCLoader#Installation|here]].

Interested in installing mods? Check [[Installing mods|here]].

Interested in making your own mods? Check [[CrossCode Modding Tutorial|here]].

Template:Big/doc

2023-05-29T16:36:30Z

Lexisother: Documentation description

<templatedata>
{
"params": {
"1": {
"aliases": [
"text"
],
"label": "Text",
"description": "The text to show.",
"type": "string",
"required": true
}
},
"description": "Show some text as 1.2x its usual size."
}
</templatedata>

Template:Big/doc

2023-05-29T16:35:01Z

Lexisother: Add documentation

<templatedata>
{
"params": {
"1": {
"aliases": [
"text"
],
"label": "Text",
"description": "The text to show.",
"type": "string",
"required": true
}
}
}
</templatedata>

Template:Note

2023-05-29T16:30:04Z

Lexisother: Use Doc template instead of manual inclusion

<onlyinclude>{{#if: {{#if:{{{1|{{{text|}}}}}}|{{{1|{{{text|}}}}}}|{{#if:<noinclude>demo</noinclude>|demo|{{{demo|}}}}} }} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}}
|gotcha=error
|=info
|#default={{{2|{{{type|}}}}}}
}} {{#ifeq:{{{inline|}}}|1|note-inline}}">[[File:Ui note {{{2|{{{type|info}}}}}}.svg|24px]]{{{1|{{{text}}}}}}</div>
| [[File:Ui note reminder.svg|18px|alt=Note|link=]] '''Note:''' }}</onlyinclude>
{{documentation|content=
== Usage ==
<pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|alert}}
{{Note|Foo|error}}
{{Note}} Loose test

* Text {{Note|Foo|inline=1}}
</pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|warn}}
{{Note|Foo|error}}
{{Note}} Loose test

* Text {{Note|Foo|inline=1}}

== Parameters ==

<noinclude>{{doc}}</noinclude>

}}
[[Category:Templates:{{PAGENAME}}]]

Template:TemplateData header

2023-05-29T16:29:38Z

Lexisother: Remove trailing semicolon

<div class="templatedata-header">{{#if:{{{noheader|}}}||This is the {{#if:{{{nolink|}}}|TemplateData|[[Wikipedia:TemplateData|TemplateData]]}} documentation for this template used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools.}}

'''TemplateData for {{{1|{{BASEPAGENAME}}}}}'''
</div><includeonly>{{#invoke:Check for unknown parameters|check
|unknown={{template other|1=[[Category:Pages using TemplateData header with unknown parameters|_VALUE_]]}}
|template=Template:TemplateData header
|1 |nolink |noheader
|preview=<div class="error" style="font-weight:normal">Unknown parameter '_VALUE_' in [[Template:TemplateData header]].</div>
}}{{template other|{{sandbox other||
[[Category:Templates using TemplateData]]

}}}}</includeonly><noinclude>{{Documentation}}</noinclude>

Template:TemplateData header

2023-05-29T16:26:21Z

Lexisother: Remove the parameter usage link

<div class="templatedata-header">{{#if:{{{noheader|}}}||This is the {{#if:{{{nolink|}}}|TemplateData|[[Wikipedia:TemplateData|TemplateData]]}} documentation for this template used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools;}}

'''TemplateData for {{{1|{{BASEPAGENAME}}}}}'''
</div><includeonly>{{#invoke:Check for unknown parameters|check
|unknown={{template other|1=[[Category:Pages using TemplateData header with unknown parameters|_VALUE_]]}}
|template=Template:TemplateData header
|1 |nolink |noheader
|preview=<div class="error" style="font-weight:normal">Unknown parameter '_VALUE_' in [[Template:TemplateData header]].</div>
}}{{template other|{{sandbox other||
[[Category:Templates using TemplateData]]

}}}}</includeonly><noinclude>{{Documentation}}</noinclude>

Template:Note/styles.css

2023-05-29T16:09:24Z

Lexisother: Vertically center the note text

/* Taken from https://www.mediawiki.org/w/index.php?title=Template:Note/styles.css&oldid=4199118 */
.note {
display: flex;
align-items: center;
background-position: left 7px top 50%;
padding: 0.5em 0.5em 0.5em 10px;
margin: 0.5em 0;
overflow: hidden;
background-color: #f8f9fa;
background-repeat: no-repeat;
border: 1px solid #ddd;
}
.note a {
padding-right: 5px;
}
.note-inline {
display: inline-block;
vertical-align: middle;
}
.note-info {
background-color: #f6efe5;
border-color: #ac6600;
min-height: 28px;
}
.note-reminder {
background-color: #fff9ea;
border-color: #fc3;
min-height: 28px;
}
.note-warn {
background-color: #fff9ea;
border-color: #fc3;
min-height: 28px;
}

.note-error {
background-color: #fee7e6;
border-color: #c33;
min-height: 28px;
}

Template:Note

2023-05-29T13:10:36Z

Lexisother: Inline icons within the note

<onlyinclude>{{#if: {{#if:{{{1|{{{text|}}}}}}|{{{1|{{{text|}}}}}}|{{#if:<noinclude>demo</noinclude>|demo|{{{demo|}}}}} }} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}}
|gotcha=error
|=info
|#default={{{2|{{{type|}}}}}}
}} {{#ifeq:{{{inline|}}}|1|note-inline}}">[[File:Ui note {{{2|{{{type|info}}}}}}.svg|24px]]{{{1|{{{text}}}}}}</div>
| [[File:Ui note reminder.svg|18px|alt=Note|link=]] '''Note:''' }}</onlyinclude>
{{documentation|content=
== Usage ==
<pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|alert}}
{{Note|Foo|error}}
{{Note}} Loose test

* Text {{Note|Foo|inline=1}}
</pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|warn}}
{{Note|Foo|error}}
{{Note}} Loose test

* Text {{Note|Foo|inline=1}}

== Parameters ==

{{Note/doc}}

}}
[[Category:Templates:{{PAGENAME}}]]

Template:Note/styles.css

2023-05-29T13:09:14Z

Lexisother: Offset the note content from the icon

Template:Note/styles.css

2023-05-29T13:05:31Z

Lexisother: Stop using background-image for adding icons

File:Ui note notice.svg

2023-05-29T12:47:00Z

Lexisother: Lexisother moved page File:Ui note notice.svg to File:Ui note error.svg: Change name for new Note structure

#REDIRECT [[File:Ui note error.svg]]

File:Ui note error.svg

2023-05-29T12:47:00Z

Lexisother: Lexisother moved page File:Ui note notice.svg to File:Ui note error.svg: Change name for new Note structure

== Licensing (MIT) ==

Copyright © 2011–2018 [https://phabricator.wikimedia.org/diffusion/GOJU/browse/master/AUTHORS.txt OOjs UI Team and other contributors]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The Software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the Software.

File:Ui note alert.svg

2023-05-29T12:46:58Z

Lexisother: Lexisother moved page File:Ui note alert.svg to File:Ui note warn.svg: Change name for new Note structure

#REDIRECT [[File:Ui note warn.svg]]

File:Ui note warn.svg

2023-05-29T12:46:58Z

Lexisother: Lexisother moved page File:Ui note alert.svg to File:Ui note warn.svg: Change name for new Note structure

Patching

2023-05-26T16:18:04Z

Lexisother: Change heading sizes

<big>'''NOTE:''' This article needs editing!!!</big>

= What is patching? =

In the scope modding, patching is changing the original game content in any way.

= How do I patch game files? =

There is more than one way to patch the game. This page will walk you through the various ways to patch.

== Asset Replacement ==

This is the most basic type of patching (anyone can do it).

This is a standard modloader feature that allows you to replace any file the game loads with your own.

=== Process ===

Inside your mod folder, create a folder called <code>assets</code>.

[[File:Mod-assets-folder.png|class=block-img]]

Decide what file you want to replace. For this tutorial, I will be showing you how to replace Lea's portraits.

Find the original relative path to asset of interest.

[[File:Lea-face-path.png|class=block-img]]

All you have to do is now mimic the folder structure.

In this example, two folders need to be created.

Inside the <code>assets</code> folder in your mod, create a <code>media</code> folder. Inside the <code>media</code> folder, create a <code>face</code> folder.

Finally, add the file you want to replace (your own <code>lea.png</code>).

It should end up looking something like this.

[[File:Faceless-mod-path-example.png|class=block-img]]

[[File:Faceless-mod-folder-contents-example.png|class=block-img]]

That is it!

You can find more examples in the [[github:CCDirectLink/CCAssetSwaps]] repo.

* Used faceless Lea mod for some of the demonstration

== JSON Patching (Object Patching) ==

Note: This requires some know of the JSON format and some programming concepts

As the majority of the game assets are json files, this is really useful to know about.

What this allows you to do is modify any json file without doing a file replacement.

The same ideas apply as assets override, except the file will have <code>.patch</code> added to the full file name.

You need to have file extensions visible in order to modify it.

=== Process ===

Let's say you want to patch a file <code>assets/data/test.json</code> with this as the contents:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 100,
"xp": 500
}
}
</syntaxhighlight>

Your mod is located at <code>assets/mods/my-mod/</code>

You would create a file with the filepath <code>assets/mods/my-mod/assets/data/test.json.patch</code>

To replace "storage.level" with 200, <code>test.json.patch</code> would look like this:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200
}
}
</syntaxhighlight>

To add "storage.name":

<syntaxhighlight lang="js">
{
"storage" : {
"name": "Shizuka"
}
}
</syntaxhighlight>

Object patching is useful for adding new properties and modifying existing ones.

Weakness: - Inability to removal properties - Arrays are hard to patch

== Patch Steps ==

Patch Steps is another way to perform json file Patching. It is more powerful than Object Patching.

The only difference between Object Patching and Patch Steps is the format of the <code>.patch</code> file.

We will be using the same sample json file used to demonstrate how Object Patching works.

Location: <code>assets/data/test.json</code>

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200
}
}
</syntaxhighlight>

Below is a list of all the valid patch steps.

=== ENTER ===

This changes the context of a patch.

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage"]
}]
</syntaxhighlight>

or

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": "storage"
}]
</syntaxhighlight>

would change the internal view of:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</syntaxhighlight>

to

<syntaxhighlight lang="js">
{
"level": 200,
"saves": [{
"data": "blob"
}]
}
</syntaxhighlight>

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage", "saves", 0]
}]
</syntaxhighlight>

would change the internal view of:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</syntaxhighlight>

to

<syntaxhighlight lang="js">
{
"data": "blob"
}
</syntaxhighlight>

=== EXIT ===

For every <code>ENTER</code>, there should be at least one <code>EXIT</code>.

<code>EXIT</code> undos an <code>ENTER</code>.

<syntaxhighlight lang="js">
[{
"type": "EXIT"
}]
</syntaxhighlight>

is equivalent to

<syntaxhighlight lang="js">
[{
"type": "EXIT",
"count": 1
}]
</syntaxhighlight>

For demonstration purposes, this is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

and this is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage", "user"]
}, {
"type": "EXIT",
"count": 2
}]
</syntaxhighlight>

The first step will produce the internal result of:

<syntaxhighlight lang="js">
{
"name": 20
}
</syntaxhighlight>

The second step will undo the first leading to the initial state.

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

=== SET_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "SET_KEY",
"index": "storage"
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "SET_KEY",
"index": "storage",
"content": 2
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{
"storage": 2
}
</syntaxhighlight>

=== INIT_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INIT_KEY",
"index": "storage",
"content": {
"a": 2
}
}]
</syntaxhighlight>

Nothing will change to the data because "storage" already exists.

Changing <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<syntaxhighlight lang="js">
[{
"type": "INIT_KEY",
"index": "storage2",
"content": {
"a": 2
}
}]
</syntaxhighlight>

would result in:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
},
"storage2": {
"a": 2
}
}
</syntaxhighlight>

=== REMOVE_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": [1,2,3]
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "REMOVE_ARRAY_ELEMENT",
"index": 0
}]
</syntaxhighlight>

Applying the patch will result in this:

<syntaxhighlight lang="js">
{
"a": [2,3]
}
</syntaxhighlight>

=== ADD_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": [1,2,3]
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": "a"
},{
"type": "ADD_ARRAY_ELEMENT",
"content": 4
}, {
"type": "ADD_ARRAY_ELEMENT",
"index": 0,
"content": 0
}, {
"type": "EXIT"
}]
</syntaxhighlight>

After the first step, the internal state will be:

<syntaxhighlight lang="js">
[1,2,3]
</syntaxhighlight>

After the second step, the number 4 will be pushed to the end of the array:

<syntaxhighlight lang="js">
[1,2,3,4]
</syntaxhighlight>

After the third step, the number 0 will be added to the start of the array:

<syntaxhighlight lang="js">
[0,1,2,3,4]
</syntaxhighlight>

The last step will revert the value of focus to the initial object:

<syntaxhighlight lang="js">
{
"a": [0,1,2,3,4]
}
</syntaxhighlight>

=== IMPORT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/data/test2.json</code>:

<syntaxhighlight lang="js">
{
"b": {
"a": 2
},
"c": {
"a": 3
},
"d": 4
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "data/test2.json"
}]
</syntaxhighlight>

This is equivalent to:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "game:data/test2.json"
}]
</syntaxhighlight>

The first step would load <code>assets/data/test2.json</code> then merge it with the current value resulting in this:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"b": {
"a": 2
},
,
"c": {
"a": 3
},
"d": 4
}
</syntaxhighlight>

If <code>assets/data/test2.json</code> had patches associated with it, it would be applied before being merged.

Another feature is loading json files inside the mod directory and merging. No patches to the loaded file will be done if <code>mod:</code> is specified.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "mod:patches/data/test.json",
"path": ["1", "2", "3"],
"index": "y"
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

First it will load <code>assets/mods/my-mod/patches/data/test.json</code>.

Then it will walk the path specified.

Initial loaded file internal representation:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

After entering "1":

<syntaxhighlight lang="js">
{
"2": {
"3": 4
}
}
</syntaxhighlight>

After entering "2":

<syntaxhighlight lang="js">
{
"3": 4
}
</syntaxhighlight>

After entering "3":

<syntaxhighlight lang="js">
4
</syntaxhighlight>

Finally, it will add a key "y" with the value that resulted from the path walk (4).

So the overall result will be:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"y": 4
}
</syntaxhighlight>

Note: "index" and "path" options are optional.

=== INCLUDE ===

The purpose of <code>INCLUDE</code> is to allow external Object Patching or PatchSteps to be performed.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

This is like setting the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

However, <code>INCLUDE</code> is used as an organization method.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}, {
"type": "SET_KEY",
"index": "b",
"content": [1,2,3]
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["a"]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"b": [1,2,3]
}
</syntaxhighlight>

Think of PatchStep files as its own room. What include does is generate a new room to perform some special operation. Rooms do not intefere with each other, they just modify the data.

=== FOR_IN ===

This PatchStep is useful for combining repeated set of PatchSteps with only slightly variations in input.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__INDEX__",
"values": [1,2,3,4],
"body": [{
"type": "SET_KEY",
"index": "__INDEX__-id",
"content": "__INDEX__"
}]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"1-id": "1",
"2-id": "2",
"3-id": "3",
"4-id": "4"
}
</syntaxhighlight>

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": {
"name": "__NAME__",
"id": "__ID__"
},
"values": [{
"name": "Bob",
"id": 1
},{
"name": "Joe",
"id": 2
}],
"body": [{
"type": "SET_KEY",
"index": "__NAME__",
"content": "__ID__"
}]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"Bob": "1",
"Joe": "2"
}
</syntaxhighlight>

=== COPY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__",
}, {
"type": "EXIT"
}]
}]
</syntaxhighlight>

Nothing will change. All this will do is create an internal key-value storage that looks like this:

{ "alias-a": 2, "alias-b": [3], "alias-c": { "d": 4 } }

=== MERGE_CONTENT ===

With the following data:

<syntaxhighlight lang="js">
{
"a": 1,
"b": 2
}
</syntaxhighlight>

And the following patch step:

<syntaxhighlight lang="js">
{
"type": "MERGE_CONTENT",
"content": {
"a": 3,
"c": 4
}
}
</syntaxhighlight>

<code>MERGE_CONTENT</code> would modify the data to be:

<syntaxhighlight lang="js">
{
"a": 3,
"b": 2,
"c": 4
}
</syntaxhighlight>

For an array, it would work the same way - effectively acting as multiple <code>ADD_ARRAY_ELEMENT</code> steps being executed at the end of the array.

=== PASTE ===

This command relies on COPY.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__"
},{
"type": "EXIT"
},{
"type": "SET_KEY",
"index": "__VAR__"
}]
}, {
"type": "SET_KEY",
"index": "saved",
"content": {}
}, {
"type": "ENTER",
"index": "saved"
}, {
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "PASTE",
"alias": "alias-__VAR__",
"index": "__VAR__"
}]
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{
"saved": {
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
}
</syntaxhighlight>

=== CALL ===

This step allows you to call a custom step.

First, you define a custom step.

{{Note
|text=The following code must be ran BEFORE prestart! That being during plugin, preload, or postload.
|type=reminder
}}

<syntaxhighlight lang="js">
simplifyResources.patchSteps.callable.register("YOUR_ID", (state, args) => {
console.log(args);
});
</syntaxhighlight>

Then, in your patch file:
<syntaxhighlight lang="js">
[{
"type": "CALL",
"id": "YOUR_ID",
"args": {
"someArg": 1
}
}]
</syntaxhighlight>

This would log <code>{ someArg: 1 }</code> to the console whenever the step is called.

If you think patch steps are lacking in some way, <code>CALL</code> allows you to define your own steps that process your args in some way without having to contribute back to the library.

=== DEBUG ===

<syntaxhighlight lang="js">
[{
"type": "DEBUG",
"value": true
}, {
"type": "DEBUG",
"value": false
}]
</syntaxhighlight>

This PatchStep turns Debug Mode on or off.

=== COMMENT ===

Debug mode must be on for this PatchStep to work.

<syntaxhighlight lang="js">
[{
"type": "DEBUG",
"value": true
},{
"type": "COMMENT",
"value": "This is a comment"
}, {
"type": "COMMENT",
"value": {
"data": 3
}
}]
</syntaxhighlight>

This will first display <code>This is a comment</code> in the DevTools console. It will then display <code>{data: 3}</code>.

[[Category:Modding guides]]

Patching

2023-05-25T20:08:06Z

Lexisother: /* CALL */ Move the note to a real note

<big>'''NOTE:''' This article needs editing!!!</big>

= What is patching? =

In the scope modding, patching is changing the original game content in any way.

= How do I patch game files? =

There is more than one way to patch the game. This page will walk you through the various ways to patch.

<hr>

= Asset Replacement =

This is the most basic type of patching (anyone can do it).

This is a standard modloader feature that allows you to replace any file the game loads with your own.

== Process ==

Inside your mod folder, create a folder called <code>assets</code>.

[[File:Mod-assets-folder.png|class=block-img]]

Decide what file you want to replace. For this tutorial, I will be showing you how to replace Lea's portraits.

Find the original relative path to asset of interest.

[[File:Lea-face-path.png|class=block-img]]

All you have to do is now mimic the folder structure.

In this example, two folders need to be created.

Inside the <code>assets</code> folder in your mod, create a <code>media</code> folder. Inside the <code>media</code> folder, create a <code>face</code> folder.

Finally, add the file you want to replace (your own <code>lea.png</code>).

It should end up looking something like this.

[[File:Faceless-mod-path-example.png|class=block-img]]

[[File:Faceless-mod-folder-contents-example.png|class=block-img]]

That is it!

You can find more examples in the [[github:CCDirectLink/CCAssetSwaps]] repo.

* Used faceless Lea mod for some of the demonstration

= JSON Patching (Object Patching) =

Note: This requires some know of the JSON format and some programming concepts

As the majority of the game assets are json files, this is really useful to know about.

What this allows you to do is modify any json file without doing a file replacement.

The same ideas apply as assets override, except the file will have <code>.patch</code> added to the full file name.

You need to have file extensions visible in order to modify it.

== Process ==

Let's say you want to patch a file <code>assets/data/test.json</code> with this as the contents:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 100,
"xp": 500
}
}
</syntaxhighlight>

Your mod is located at <code>assets/mods/my-mod/</code>

You would create a file with the filepath <code>assets/mods/my-mod/assets/data/test.json.patch</code>

To replace "storage.level" with 200, <code>test.json.patch</code> would look like this:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200
}
}
</syntaxhighlight>

To add "storage.name":

<syntaxhighlight lang="js">
{
"storage" : {
"name": "Shizuka"
}
}
</syntaxhighlight>

Object patching is useful for adding new properties and modifying existing ones.

Weakness: - Inability to removal properties - Arrays are hard to patch

= Patch Steps =

Patch Steps is another way to perform json file Patching. It is more powerful than Object Patching.

The only difference between Object Patching and Patch Steps is the format of the <code>.patch</code> file.

We will be using the same sample json file used to demonstrate how Object Patching works.

Location: <code>assets/data/test.json</code>

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200
}
}
</syntaxhighlight>

== Appliers ==

An Applier is a Patch Step command.

== Patch Step Appliers ==

=== ENTER ===

This changes the context of a patch.

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage"]
}]
</syntaxhighlight>

or

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": "storage"
}]
</syntaxhighlight>

would change the internal view of:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</syntaxhighlight>

to

<syntaxhighlight lang="js">
{
"level": 200,
"saves": [{
"data": "blob"
}]
}
</syntaxhighlight>

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage", "saves", 0]
}]
</syntaxhighlight>

would change the internal view of:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</syntaxhighlight>

to

<syntaxhighlight lang="js">
{
"data": "blob"
}
</syntaxhighlight>

=== EXIT ===

For every <code>ENTER</code>, there should be at least one <code>EXIT</code>.

<code>EXIT</code> undos an <code>ENTER</code>.

<syntaxhighlight lang="js">
[{
"type": "EXIT"
}]
</syntaxhighlight>

is equivalent to

<syntaxhighlight lang="js">
[{
"type": "EXIT",
"count": 1
}]
</syntaxhighlight>

For demonstration purposes, this is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

and this is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage", "user"]
}, {
"type": "EXIT",
"count": 2
}]
</syntaxhighlight>

The first step will produce the internal result of:

<syntaxhighlight lang="js">
{
"name": 20
}
</syntaxhighlight>

The second step will undo the first leading to the initial state.

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

=== SET_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "SET_KEY",
"index": "storage"
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "SET_KEY",
"index": "storage",
"content": 2
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{
"storage": 2
}
</syntaxhighlight>

=== INIT_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INIT_KEY",
"index": "storage",
"content": {
"a": 2
}
}]
</syntaxhighlight>

Nothing will change to the data because "storage" already exists.

Changing <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<syntaxhighlight lang="js">
[{
"type": "INIT_KEY",
"index": "storage2",
"content": {
"a": 2
}
}]
</syntaxhighlight>

would result in:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
},
"storage2": {
"a": 2
}
}
</syntaxhighlight>

=== REMOVE_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": [1,2,3]
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "REMOVE_ARRAY_ELEMENT",
"index": 0
}]
</syntaxhighlight>

Applying the patch will result in this:

<syntaxhighlight lang="js">
{
"a": [2,3]
}
</syntaxhighlight>

=== ADD_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": [1,2,3]
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": "a"
},{
"type": "ADD_ARRAY_ELEMENT",
"content": 4
}, {
"type": "ADD_ARRAY_ELEMENT",
"index": 0,
"content": 0
}, {
"type": "EXIT"
}]
</syntaxhighlight>

After the first step, the internal state will be:

<syntaxhighlight lang="js">
[1,2,3]
</syntaxhighlight>

After the second step, the number 4 will be pushed to the end of the array:

<syntaxhighlight lang="js">
[1,2,3,4]
</syntaxhighlight>

After the third step, the number 0 will be added to the start of the array:

<syntaxhighlight lang="js">
[0,1,2,3,4]
</syntaxhighlight>

The last step will revert the value of focus to the initial object:

<syntaxhighlight lang="js">
{
"a": [0,1,2,3,4]
}
</syntaxhighlight>

=== IMPORT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/data/test2.json</code>:

<syntaxhighlight lang="js">
{
"b": {
"a": 2
},
"c": {
"a": 3
},
"d": 4
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "data/test2.json"
}]
</syntaxhighlight>

This is equivalent to:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "game:data/test2.json"
}]
</syntaxhighlight>

The first step would load <code>assets/data/test2.json</code> then merge it with the current value resulting in this:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"b": {
"a": 2
},
,
"c": {
"a": 3
},
"d": 4
}
</syntaxhighlight>

If <code>assets/data/test2.json</code> had patches associated with it, it would be applied before being merged.

Another feature is loading json files inside the mod directory and merging. No patches to the loaded file will be done if <code>mod:</code> is specified.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "mod:patches/data/test.json",
"path": ["1", "2", "3"],
"index": "y"
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

First it will load <code>assets/mods/my-mod/patches/data/test.json</code>.

Then it will walk the path specified.

Initial loaded file internal representation:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

After entering "1":

<syntaxhighlight lang="js">
{
"2": {
"3": 4
}
}
</syntaxhighlight>

After entering "2":

<syntaxhighlight lang="js">
{
"3": 4
}
</syntaxhighlight>

After entering "3":

<syntaxhighlight lang="js">
4
</syntaxhighlight>

Finally, it will add a key "y" with the value that resulted from the path walk (4).

So the overall result will be:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"y": 4
}
</syntaxhighlight>

Note: "index" and "path" options are optional.

=== INCLUDE ===

The purpose of <code>INCLUDE</code> is to allow external Object Patching or PatchSteps to be performed.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

This is like setting the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

However, <code>INCLUDE</code> is used as an organization method.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}, {
"type": "SET_KEY",
"index": "b",
"content": [1,2,3]
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["a"]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"b": [1,2,3]
}
</syntaxhighlight>

Think of PatchStep files as its own room. What include does is generate a new room to perform some special operation. Rooms do not intefere with each other, they just modify the data.

=== FOR_IN ===

This PatchStep is useful for combining repeated set of PatchSteps with only slightly variations in input.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__INDEX__",
"values": [1,2,3,4],
"body": [{
"type": "SET_KEY",
"index": "__INDEX__-id",
"content": "__INDEX__"
}]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"1-id": "1",
"2-id": "2",
"3-id": "3",
"4-id": "4"
}
</syntaxhighlight>

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": {
"name": "__NAME__",
"id": "__ID__"
},
"values": [{
"name": "Bob",
"id": 1
},{
"name": "Joe",
"id": 2
}],
"body": [{
"type": "SET_KEY",
"index": "__NAME__",
"content": "__ID__"
}]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"Bob": "1",
"Joe": "2"
}
</syntaxhighlight>

=== COPY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__",
}, {
"type": "EXIT"
}]
}]
</syntaxhighlight>

Nothing will change. All this will do is create an internal key-value storage that looks like this:

{ "alias-a": 2, "alias-b": [3], "alias-c": { "d": 4 } }

=== MERGE_CONTENT ===

With the following data:

<syntaxhighlight lang="js">
{
"a": 1,
"b": 2
}
</syntaxhighlight>

And the following patch step:

<syntaxhighlight lang="js">
{
"type": "MERGE_CONTENT",
"content": {
"a": 3,
"c": 4
}
}
</syntaxhighlight>

<code>MERGE_CONTENT</code> would modify the data to be:

<syntaxhighlight lang="js">
{
"a": 3,
"b": 2,
"c": 4
}
</syntaxhighlight>

For an array, it would work the same way - effectively acting as multiple <code>ADD_ARRAY_ELEMENT</code> steps being executed at the end of the array.

=== PASTE ===

This command relies on COPY.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__"
},{
"type": "EXIT"
},{
"type": "SET_KEY",
"index": "__VAR__"
}]
}, {
"type": "SET_KEY",
"index": "saved",
"content": {}
}, {
"type": "ENTER",
"index": "saved"
}, {
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "PASTE",
"alias": "alias-__VAR__",
"index": "__VAR__"
}]
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{
"saved": {
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
}
</syntaxhighlight>

=== CALL ===

This step allows you to call a custom step.

First, you define a custom step.

{{Note
|text=The following code must be ran BEFORE prestart! That being during plugin, preload, or postload.
|type=reminder
}}

<syntaxhighlight lang="js">
simplifyResources.patchSteps.callable.register("YOUR_ID", (state, args) => {
console.log(args);
});
</syntaxhighlight>

Then, in your patch file:
<syntaxhighlight lang="js">
[{
"type": "CALL",
"id": "YOUR_ID",
"args": {
"someArg": 1
}
}]
</syntaxhighlight>

This would log <code>{ someArg: 1 }</code> to the console whenever the step is called.

If you think patch steps are lacking in some way, <code>CALL</code> allows you to define your own steps that process your args in some way without having to contribute back to the library.

=== DEBUG ===

<syntaxhighlight lang="js">
[{
"type": "DEBUG",
"value": true
}, {
"type": "DEBUG",
"value": false
}]
</syntaxhighlight>

This PatchStep turns Debug Mode on or off.

=== COMMENT ===

Debug mode must be on for this PatchStep to work.

<syntaxhighlight lang="js">
[{
"type": "DEBUG",
"value": true
},{
"type": "COMMENT",
"value": "This is a comment"
}, {
"type": "COMMENT",
"value": {
"data": 3
}
}]
</syntaxhighlight>

This will first display <code>This is a comment</code> in the DevTools console. It will then display <code>{data: 3}</code>.

[[Category:Modding guides]]

Template:Note/doc

2023-05-25T19:48:06Z

Lexisother: Add documentation for the Note template

{{Documentation subpage}}

{{TemplateData header}}
<templatedata>
{
"format": "inline",
"description": {
"en": "Show a note in a box (e.g. a top-of-the-page warning)."
},
"params": {
"1": {
"aliases": [
"text"
],
"label": {
"en": "Text"
},
"description": {
"en": "Informative note."
},
"required": true,
"type": "content"
},
"inline": {
"label": {
"en": "Inline formatting"
},
"description": {
"en": "Show the template without line breaks before and after it."
},
"default": "0",
"autovalue": "1",
"type": "boolean"
},
"type": {
"aliases": [
"2"
],
"label": {
"en": "Type"
},
"description": {
"en": "One of “info”, “reminder”, “warn”, or “error”. This setting affects the color and icon."
},
"suggestedvalues": [
"info",
"reminder",
"warn",
"error"
],
"default": "info",
"type": "string"
}
},
"paramOrder": [
"inline",
"type",
"1"
]
}
</templatedata>
<includeonly>{{Sandbox other||

[[Category:Notice templates]]
}}</includeonly>

Template:Documentation subpage

2023-05-25T19:46:42Z

Lexisother:

<includeonly>{{#ifeq:{{lc:{{SUBPAGENAME}}}} |{{{override|doc}}}
| 
</includeonly>{{#ifeq:{{{doc-notice|show}}} |show
| {{Note
|
'''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[Wikipedia:Categorization|categories]] and other content that is not part of the original {{#if:{{{text2|}}} |{{{text2}}} |{{#if:{{{text1|}}} |{{{text1}}} |{{#ifeq:{{SUBJECTSPACE}} |{{ns:User}} |{{lc:{{SUBJECTSPACE}}}} template page |{{#if:{{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}}}}}}}}.
}}
}}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{#if:{{{inhibit|}}} |
| <includeonly>{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
| [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
| [[Category:Documentation subpages without corresponding pages]]
}}</includeonly>
}}<includeonly>
| 
}}</includeonly><noinclude>{{Documentation}}</noinclude>

Template:Note

2023-05-25T19:43:58Z

Lexisother: Created page with "<onlyinclude>{{#if: {{#if:{{{1|{{{text|}}}}}}|{{{1|{{{text|}}}}}}|{{#if:<noinclude>demo</noinclude>|demo|{{{demo|}}}}} }} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}} |gotcha=error |=info |#default={{{2|{{{type|}}}}}} }} {{#ifeq:{{{inline|}}}|1|note-inline}}">{{{1|{{{text}}}}}}</div> | link= '''Note:''' }}</onlyinclude> {{documentation|..."

<onlyinclude>{{#if: {{#if:{{{1|{{{text|}}}}}}|{{{1|{{{text|}}}}}}|{{#if:<noinclude>demo</noinclude>|demo|{{{demo|}}}}} }} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}}
|gotcha=error
|=info
|#default={{{2|{{{type|}}}}}}
}} {{#ifeq:{{{inline|}}}|1|note-inline}}">{{{1|{{{text}}}}}}</div>
| [[File:Ui note reminder.svg|18px|alt=Note|link=]] '''Note:''' }}</onlyinclude>
{{documentation|content=
== Usage ==
<pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|alert}}
{{Note|Foo|error}}
{{Note}} Loose test

* Text {{Note|Foo|inline=1}}
</pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|warn}}
{{Note|Foo|error}}
{{Note}} Loose test

* Text {{Note|Foo|inline=1}}

== Parameters ==

{{Note/doc}}

}}
[[Category:Templates:{{PAGENAME}}]]

File:Test Template Info-Icon - Version (2).svg

2023-05-25T19:26:27Z

Lexisother: Add the license

== Licensing (CC0) ==

<pre>
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
</pre>

File:Test Template Info-Icon - Version (2).svg

2023-05-25T19:21:14Z

Lexisother:

Template:Note/styles.css

2023-05-25T19:13:03Z

Lexisother: Update the icon URLs

/* Taken from https://www.mediawiki.org/w/index.php?title=Template:Note/styles.css&oldid=4199118 */
.note {
background-position: left 7px top 50%;
padding: 0.5em 0.5em 0.5em 40px;
margin: 0.5em 0;
overflow: hidden;
background-color: #f8f9fa;
background-repeat: no-repeat;
border: 1px solid #ddd;
}
.note-inline {
display: inline-block;
vertical-align: middle;
}
.note-info {
background-color: #f6efe5;
/* [[File:Ui note info.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/a/a7/Ui_note_info.svg);
background-size: 25px;
border-color: #ac6600;
padding-left: 40px;
min-height: 28px;
}
.note-reminder {
background-color: #fff9ea;
/* [[File:Ui note reminder.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/f/fd/Ui_note_reminder.svg);
background-size: 25px;
border-color: #fc3;
min-height: 28px;
}
.note-warn {
background-color: #fff9ea;
/* [[File:Ui note alert.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/0/04/Ui_note_alert.svg);
background-size: 25px;
border-color: #fc3;
min-height: 28px;
}

.note-error {
background-color: #fee7e6;
/* [[File:Ui note notice.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/3/39/Ui_note_notice.svg);
background-size: 25px;
border-color: #c33;
min-height: 28px;
}

Template:Note/styles.css

2023-05-25T18:52:55Z

Lexisother: Add the MediaWiki note styles

/* Taken from https://www.mediawiki.org/w/index.php?title=Template:Note/styles.css&oldid=4199118 */
.note {
background-position: left 7px top 50%;
padding: 0.5em 0.5em 0.5em 40px;
margin: 0.5em 0;
overflow: hidden;
background-color: #f8f9fa;
background-repeat: no-repeat;
border: 1px solid #ddd;
}
.note-inline {
display: inline-block;
vertical-align: middle;
}
.note-info {
background-color: #f6efe5;
/* [[File:Ui note info.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/3/39/Ui_note_info.svg);
background-size: 25px;
border-color: #ac6600;
padding-left: 40px;
min-height: 28px;
}
.note-reminder {
background-color: #fff9ea;
/* [[File:Ui note reminder.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/3/39/Ui_note_reminder.svg);
background-size: 25px;
border-color: #fc3;
min-height: 28px;
}
.note-warn {
background-color: #fff9ea;
/* [[File:Ui note alert.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/3/39/Ui_note_alert.svg);
background-size: 25px;
border-color: #fc3;
min-height: 28px;
}

.note-error {
background-color: #fee7e6;
/* [[File:Ui note notice.svg]] */
background-image: url(https://wiki.c2dl.info/w/images/3/39/Ui_note_notice.svg);
background-size: 25px;
border-color: #c33;
min-height: 28px;
}

Module:Documentation/styles.css

2023-05-25T18:50:00Z

Lexisother: Add Wikipedia's documentation styles

/* {{pp|small=yes}} */
.documentation,
.documentation-metadata {
border: 1px solid #a2a9b1;
background-color: #ecfcf4;
clear: both;
}

.documentation {
margin: 1em 0 0 0;
padding: 1em;
}

.documentation-metadata {
margin: 0.2em 0; /* same margin left-right as .documentation */
font-style: italic;
padding: 0.4em 1em; /* same padding left-right as .documentation */
}

.documentation-startbox {
padding-bottom: 3px;
border-bottom: 1px solid #aaa;
margin-bottom: 1ex;
}

.documentation-heading {
font-weight: bold;
font-size: 125%;
}

.documentation-clear { /* Don't want things to stick out where they shouldn't. */
clear: both;
}

.documentation-toolbar {
font-style: normal;
font-size: 85%;
}

File:Ui note error.svg

2023-05-25T18:32:00Z

Lexisother:

File:Ui note warn.svg

2023-05-25T18:31:33Z

Lexisother:

CCLoader

2023-05-25T13:43:19Z

Lexisother: Move the codeblock to the not-deprecated syntaxhighlight

'''CCLoader''' is the de facto modloader for CrossCode and obviously a prerequisite for playing the CrossCode with mods. Really, it is the only actively developed modloader intended for use by both mod users and mod developers (RIP [https://github.com/20kdc/decrossfuscator/blob/master/lib/rapture.js Rapture] + [https://github.com/20kdc/decrossfuscator/tree/master/mods pre-1.1.0 mods], [[Dorito]] and [[CCInjector]]).

= Installation =

There are three ways to perform CCLoader installation, they are both described in this document. But before we continue:

== '''VERY IMPORTANT NOTE:''' Don't use the green "clone or download" button! ==

[[File:Clone-or-download.png|class=block-img]]

This button downloads the source code, not the compiled files! In the case of CCLoader you can't just download the source code and run it because CCLoader is not written in JavaScript! While this doesn't apply to all CrossCode mods out there as most of them are written in plain JS and as such don't need to be compiled, '''you should get used to looking at the "Releases" page first before trying to download the source code'''. In the new redesigned GitHub UI the link to it became more apparent:

[[File:Github-project-frontpage-releases.png|class=block-img]]

== Method 1: Quick-installation archive ==

This method is recommended for most users (at least right now because the mod manager is not stable enough for a public release and has a few critical bugs) and will very likely remain the primary installation method because of its simplicity.

# Obviously, '''first of all you have to locate the [[Locations of CrossCode files#Game files folder|CrossCode game files folder]].'''
# Go to the [https://github.com/CCDirectLink/CCLoader/releases/latest latest release page] of CCLoader.
# In the "Assets" list at the bottom of the release click the link which says '''Source code (zip)''' (a <code>tar.gz</code> download also exist for GNU/Linux and macOS users). This will download a quick installation archive.
# Extract this archive somewhere:<br>[[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this:<br>[[File:Ccloader-quick-install.png|class=block-img]]<br>The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>:<br>[[File:Ccloader-quick-install-overwrite-package-json.png|class=block-img]]
# You've now successfully installed CCLoader! The end result should look like (notice the new <code>ccloader</code> folder):<br>[[File:Ccloader-installation-end-result.png|class=block-img]]
# Mods can be installed into the <code>mods</code> folder located inside <code>assets</code>, for more information on that see the [[Installing mods|relevant guide]].

=== Bonus for Linux users ===

On Linux this entire process can be performed with two commands:

<syntaxhighlight lang="bash">
cd /path/to/CrossCode
# Replace the version in the URL here with the latest one:
curl --location --fail 'https://github.com/CCDirectLink/CCLoader/archive/refs/tags/v2.20.2/v2.10.1.zip' \
| tar --extract --gzip --verbose --file -
</syntaxhighlight>

=== Verifying a successful CCLoader installation ===

Upon launching the game you'll see the CCLoader version in the bottom right corner of the title screen and at the top of the pause screen (where the game version is) if CCLoader was installed correctly. You'll also be able to see the following tab in the options menu:

[[File:Ccloader-mod-settings-menu.png|class=block-img]]

It will obviously be empty if you haven't [[Installing mods|installed any mods]].

== Method 2: Using the automatic installer ==

See https://github.com/CCDirectLink/ccloader-installer. It may be broken though.

[[Category:Modloaders]]

Patching

2023-05-25T13:41:16Z

Lexisother: Move codeblocks to the not-deprecated syntaxhighlight

<big>'''NOTE:''' This article needs editing!!!</big>

= What is patching? =

In the scope modding, patching is changing the original game content in any way.

= How do I patch game files? =

There is more than one way to patch the game. This page will walk you through the various ways to patch.

<hr>

= Asset Replacement =

This is the most basic type of patching (anyone can do it).

This is a standard modloader feature that allows you to replace any file the game loads with your own.

== Process ==

Inside your mod folder, create a folder called <code>assets</code>.

[[File:Mod-assets-folder.png|class=block-img]]

Decide what file you want to replace. For this tutorial, I will be showing you how to replace Lea's portraits.

Find the original relative path to asset of interest.

[[File:Lea-face-path.png|class=block-img]]

All you have to do is now mimic the folder structure.

In this example, two folders need to be created.

Inside the <code>assets</code> folder in your mod, create a <code>media</code> folder. Inside the <code>media</code> folder, create a <code>face</code> folder.

Finally, add the file you want to replace (your own <code>lea.png</code>).

It should end up looking something like this.

[[File:Faceless-mod-path-example.png|class=block-img]]

[[File:Faceless-mod-folder-contents-example.png|class=block-img]]

That is it!

You can find more examples in the [[github:CCDirectLink/CCAssetSwaps]] repo.

* Used faceless Lea mod for some of the demonstration

= JSON Patching (Object Patching) =

Note: This requires some know of the JSON format and some programming concepts

As the majority of the game assets are json files, this is really useful to know about.

What this allows you to do is modify any json file without doing a file replacement.

The same ideas apply as assets override, except the file will have <code>.patch</code> added to the full file name.

You need to have file extensions visible in order to modify it.

== Process ==

Let's say you want to patch a file <code>assets/data/test.json</code> with this as the contents:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 100,
"xp": 500
}
}
</syntaxhighlight>

Your mod is located at <code>assets/mods/my-mod/</code>

You would create a file with the filepath <code>assets/mods/my-mod/assets/data/test.json.patch</code>

To replace "storage.level" with 200, <code>test.json.patch</code> would look like this:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200
}
}
</syntaxhighlight>

To add "storage.name":

<syntaxhighlight lang="js">
{
"storage" : {
"name": "Shizuka"
}
}
</syntaxhighlight>

Object patching is useful for adding new properties and modifying existing ones.

Weakness: - Inability to removal properties - Arrays are hard to patch

= Patch Steps =

Patch Steps is another way to perform json file Patching. It is more powerful than Object Patching.

The only difference between Object Patching and Patch Steps is the format of the <code>.patch</code> file.

We will be using the same sample json file used to demonstrate how Object Patching works.

Location: <code>assets/data/test.json</code>

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200
}
}
</syntaxhighlight>

== Appliers ==

An Applier is a Patch Step command.

== Patch Step Appliers ==

=== ENTER ===

This changes the context of a patch.

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage"]
}]
</syntaxhighlight>

or

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": "storage"
}]
</syntaxhighlight>

would change the internal view of:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</syntaxhighlight>

to

<syntaxhighlight lang="js">
{
"level": 200,
"saves": [{
"data": "blob"
}]
}
</syntaxhighlight>

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage", "saves", 0]
}]
</syntaxhighlight>

would change the internal view of:

<syntaxhighlight lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</syntaxhighlight>

to

<syntaxhighlight lang="js">
{
"data": "blob"
}
</syntaxhighlight>

=== EXIT ===

For every <code>ENTER</code>, there should be at least one <code>EXIT</code>.

<code>EXIT</code> undos an <code>ENTER</code>.

<syntaxhighlight lang="js">
[{
"type": "EXIT"
}]
</syntaxhighlight>

is equivalent to

<syntaxhighlight lang="js">
[{
"type": "EXIT",
"count": 1
}]
</syntaxhighlight>

For demonstration purposes, this is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

and this is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["storage", "user"]
}, {
"type": "EXIT",
"count": 2
}]
</syntaxhighlight>

The first step will produce the internal result of:

<syntaxhighlight lang="js">
{
"name": 20
}
</syntaxhighlight>

The second step will undo the first leading to the initial state.

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

=== SET_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "SET_KEY",
"index": "storage"
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "SET_KEY",
"index": "storage",
"content": 2
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{
"storage": 2
}
</syntaxhighlight>

=== INIT_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INIT_KEY",
"index": "storage",
"content": {
"a": 2
}
}]
</syntaxhighlight>

Nothing will change to the data because "storage" already exists.

Changing <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<syntaxhighlight lang="js">
[{
"type": "INIT_KEY",
"index": "storage2",
"content": {
"a": 2
}
}]
</syntaxhighlight>

would result in:

<syntaxhighlight lang="js">
{
"storage": {
"user": {
"name": 20
}
},
"storage2": {
"a": 2
}
}
</syntaxhighlight>

=== REMOVE_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": [1,2,3]
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "REMOVE_ARRAY_ELEMENT",
"index": 0
}]
</syntaxhighlight>

Applying the patch will result in this:

<syntaxhighlight lang="js">
{
"a": [2,3]
}
</syntaxhighlight>

=== ADD_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": [1,2,3]
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": "a"
},{
"type": "ADD_ARRAY_ELEMENT",
"content": 4
}, {
"type": "ADD_ARRAY_ELEMENT",
"index": 0,
"content": 0
}, {
"type": "EXIT"
}]
</syntaxhighlight>

After the first step, the internal state will be:

<syntaxhighlight lang="js">
[1,2,3]
</syntaxhighlight>

After the second step, the number 4 will be pushed to the end of the array:

<syntaxhighlight lang="js">
[1,2,3,4]
</syntaxhighlight>

After the third step, the number 0 will be added to the start of the array:

<syntaxhighlight lang="js">
[0,1,2,3,4]
</syntaxhighlight>

The last step will revert the value of focus to the initial object:

<syntaxhighlight lang="js">
{
"a": [0,1,2,3,4]
}
</syntaxhighlight>

=== IMPORT ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/data/test2.json</code>:

<syntaxhighlight lang="js">
{
"b": {
"a": 2
},
"c": {
"a": 3
},
"d": 4
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "data/test2.json"
}]
</syntaxhighlight>

This is equivalent to:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "game:data/test2.json"
}]
</syntaxhighlight>

The first step would load <code>assets/data/test2.json</code> then merge it with the current value resulting in this:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"b": {
"a": 2
},
,
"c": {
"a": 3
},
"d": 4
}
</syntaxhighlight>

If <code>assets/data/test2.json</code> had patches associated with it, it would be applied before being merged.

Another feature is loading json files inside the mod directory and merging. No patches to the loaded file will be done if <code>mod:</code> is specified.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "IMPORT",
"src": "mod:patches/data/test.json",
"path": ["1", "2", "3"],
"index": "y"
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

First it will load <code>assets/mods/my-mod/patches/data/test.json</code>.

Then it will walk the path specified.

Initial loaded file internal representation:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

After entering "1":

<syntaxhighlight lang="js">
{
"2": {
"3": 4
}
}
</syntaxhighlight>

After entering "2":

<syntaxhighlight lang="js">
{
"3": 4
}
</syntaxhighlight>

After entering "3":

<syntaxhighlight lang="js">
4
</syntaxhighlight>

Finally, it will add a key "y" with the value that resulted from the path walk (4).

So the overall result will be:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"y": 4
}
</syntaxhighlight>

Note: "index" and "path" options are optional.

=== INCLUDE ===

The purpose of <code>INCLUDE</code> is to allow external Object Patching or PatchSteps to be performed.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

This is like setting the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<syntaxhighlight lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</syntaxhighlight>

However, <code>INCLUDE</code> is used as an organization method.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}, {
"type": "SET_KEY",
"index": "b",
"content": [1,2,3]
}]
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<syntaxhighlight lang="js">
[{
"type": "ENTER",
"index": ["a"]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"a": {
"b": 2
},
"b": [1,2,3]
}
</syntaxhighlight>

Think of PatchStep files as its own room. What include does is generate a new room to perform some special operation. Rooms do not intefere with each other, they just modify the data.

=== FOR_IN ===

This PatchStep is useful for combining repeated set of PatchSteps with only slightly variations in input.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__INDEX__",
"values": [1,2,3,4],
"body": [{
"type": "SET_KEY",
"index": "__INDEX__-id",
"content": "__INDEX__"
}]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"1-id": "1",
"2-id": "2",
"3-id": "3",
"4-id": "4"
}
</syntaxhighlight>

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": {
"name": "__NAME__",
"id": "__ID__"
},
"values": [{
"name": "Bob",
"id": 1
},{
"name": "Joe",
"id": 2
}],
"body": [{
"type": "SET_KEY",
"index": "__NAME__",
"content": "__ID__"
}]
}]
</syntaxhighlight>

This results in:

<syntaxhighlight lang="js">
{
"Bob": "1",
"Joe": "2"
}
</syntaxhighlight>

=== COPY ===

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__",
}, {
"type": "EXIT"
}]
}]
</syntaxhighlight>

Nothing will change. All this will do is create an internal key-value storage that looks like this:

{ "alias-a": 2, "alias-b": [3], "alias-c": { "d": 4 } }

=== MERGE_CONTENT ===

With the following data:

<syntaxhighlight lang="js">
{
"a": 1,
"b": 2
}
</syntaxhighlight>

And the following patch step:

<syntaxhighlight lang="js">
{
"type": "MERGE_CONTENT",
"content": {
"a": 3,
"c": 4
}
}
</syntaxhighlight>

<code>MERGE_CONTENT</code> would modify the data to be:

<syntaxhighlight lang="js">
{
"a": 3,
"b": 2,
"c": 4
}
</syntaxhighlight>

For an array, it would work the same way - effectively acting as multiple <code>ADD_ARRAY_ELEMENT</code> steps being executed at the end of the array.

=== PASTE ===

This command relies on COPY.

This is the contents of <code>assets/data/test.json</code>:

<syntaxhighlight lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</syntaxhighlight>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<syntaxhighlight lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__"
},{
"type": "EXIT"
},{
"type": "SET_KEY",
"index": "__VAR__"
}]
}, {
"type": "SET_KEY",
"index": "saved",
"content": {}
}, {
"type": "ENTER",
"index": "saved"
}, {
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "PASTE",
"alias": "alias-__VAR__",
"index": "__VAR__"
}]
}]
</syntaxhighlight>

This is the result:

<syntaxhighlight lang="js">
{
"saved": {
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
}
</syntaxhighlight>

=== CALL ===

This step allows you to call a custom step.

First, you define a custom step. In a CCLoader2 mod:

<syntaxhighlight lang="js">
// NOTE: This MUST be done BEFORE prestart! That being: plugin, preload, postload
simplifyResources.patchSteps.callable.register("YOUR_ID", (state, args) => {
console.log(args);
});
</syntaxhighlight>

Then, in your patch file:
<syntaxhighlight lang="js">
[{
"type": "CALL",
"id": "YOUR_ID",
"args": {
"someArg": 1
}
}]
</syntaxhighlight>

This would log <code>{ someArg: 1 }</code> to the console whenever the step is called.

If you think patch steps are lacking in some way, <code>CALL</code> allows you to define your own steps that process your args in some way without having to contribute back to the library.

=== DEBUG ===

<syntaxhighlight lang="js">
[{
"type": "DEBUG",
"value": true
}, {
"type": "DEBUG",
"value": false
}]
</syntaxhighlight>

This PatchStep turns Debug Mode on or off.

=== COMMENT ===

Debug mode must be on for this PatchStep to work.

<syntaxhighlight lang="js">
[{
"type": "DEBUG",
"value": true
},{
"type": "COMMENT",
"value": "This is a comment"
}, {
"type": "COMMENT",
"value": {
"data": 3
}
}]
</syntaxhighlight>

This will first display <code>This is a comment</code> in the DevTools console. It will then display <code>{data: 3}</code>.

[[Category:Modding guides]]

Patching

2023-05-25T13:16:27Z

Lexisother: Add documentation for the CALL step

<big>'''NOTE:''' This article needs editing!!!</big>

= What is patching? =

In the scope modding, patching is changing the original game content in any way.

= How do I patch game files? =

There is more than one way to patch the game. This page will walk you through the various ways to patch.

<hr>

= Asset Replacement =

This is the most basic type of patching (anyone can do it).

This is a standard modloader feature that allows you to replace any file the game loads with your own.

== Process ==

Inside your mod folder, create a folder called <code>assets</code>.

[[File:Mod-assets-folder.png|class=block-img]]

Decide what file you want to replace. For this tutorial, I will be showing you how to replace Lea's portraits.

Find the original relative path to asset of interest.

[[File:Lea-face-path.png|class=block-img]]

All you have to do is now mimic the folder structure.

In this example, two folders need to be created.

Inside the <code>assets</code> folder in your mod, create a <code>media</code> folder. Inside the <code>media</code> folder, create a <code>face</code> folder.

Finally, add the file you want to replace (your own <code>lea.png</code>).

It should end up looking something like this.

[[File:Faceless-mod-path-example.png|class=block-img]]

[[File:Faceless-mod-folder-contents-example.png|class=block-img]]

That is it!

You can find more examples in the [[github:CCDirectLink/CCAssetSwaps]] repo.

* Used faceless Lea mod for some of the demonstration

= JSON Patching (Object Patching) =

Note: This requires some know of the JSON format and some programming concepts

As the majority of the game assets are json files, this is really useful to know about.

What this allows you to do is modify any json file without doing a file replacement.

The same ideas apply as assets override, except the file will have <code>.patch</code> added to the full file name.

You need to have file extensions visible in order to modify it.

== Process ==

Let's say you want to patch a file <code>assets/data/test.json</code> with this as the contents:

<source lang="js">
{
"storage" : {
"level": 100,
"xp": 500
}
}
</source>

Your mod is located at <code>assets/mods/my-mod/</code>

You would create a file with the filepath <code>assets/mods/my-mod/assets/data/test.json.patch</code>

To replace "storage.level" with 200, <code>test.json.patch</code> would look like this:

<source lang="js">
{
"storage" : {
"level": 200
}
}
</source>

To add "storage.name":

<source lang="js">
{
"storage" : {
"name": "Shizuka"
}
}
</source>

Object patching is useful for adding new properties and modifying existing ones.

Weakness: - Inability to removal properties - Arrays are hard to patch

= Patch Steps =

Patch Steps is another way to perform json file Patching. It is more powerful than Object Patching.

The only difference between Object Patching and Patch Steps is the format of the <code>.patch</code> file.

We will be using the same sample json file used to demonstrate how Object Patching works.

Location: <code>assets/data/test.json</code>

<source lang="js">
{
"storage" : {
"level": 200
}
}
</source>

== Appliers ==

An Applier is a Patch Step command.

== Patch Step Appliers ==

<source lang="js"></source>

=== ENTER ===

This changes the context of a patch.

<source lang="js">
[{
"type": "ENTER",
"index": ["storage"]
}]
</source>

or

<source lang="js">
[{
"type": "ENTER",
"index": "storage"
}]
</source>

would change the internal view of:

<source lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</source>

to

<source lang="js">
{
"level": 200,
"saves": [{
"data": "blob"
}]
}
</source>

<source lang="js">
[{
"type": "ENTER",
"index": ["storage", "saves", 0]
}]
</source>

would change the internal view of:

<source lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</source>

to

<source lang="js">
{
"data": "blob"
}
</source>

=== EXIT ===

For every <code>ENTER</code>, there should be at least one <code>EXIT</code>.

<code>EXIT</code> undos an <code>ENTER</code>.

<source lang="js">
[{
"type": "EXIT"
}]
</source>

is equivalent to

<source lang="js">
[{
"type": "EXIT",
"count": 1
}]
</source>

For demonstration purposes, this is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

and this is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "ENTER",
"index": ["storage", "user"]
}, {
"type": "EXIT",
"count": 2
}]
</source>

The first step will produce the internal result of:

<source lang="js">
{
"name": 20
}
</source>

The second step will undo the first leading to the initial state.

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

=== SET_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "SET_KEY",
"index": "storage"
}]
</source>

This is the result:

<source lang="js">
{}
</source>

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "SET_KEY",
"index": "storage",
"content": 2
}]
</source>

This is the result:

<source lang="js">
{
"storage": 2
}
</source>

=== INIT_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INIT_KEY",
"index": "storage",
"content": {
"a": 2
}
}]
</source>

Nothing will change to the data because "storage" already exists.

Changing <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<source lang="js">
[{
"type": "INIT_KEY",
"index": "storage2",
"content": {
"a": 2
}
}]
</source>

would result in:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
},
"storage2": {
"a": 2
}
}
</source>

=== REMOVE_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": [1,2,3]
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "REMOVE_ARRAY_ELEMENT",
"index": 0
}]
</source>

Applying the patch will result in this:

<source lang="js">
{
"a": [2,3]
}
</source>

=== ADD_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": [1,2,3]
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "ENTER",
"index": "a"
},{
"type": "ADD_ARRAY_ELEMENT",
"content": 4
}, {
"type": "ADD_ARRAY_ELEMENT",
"index": 0,
"content": 0
}, {
"type": "EXIT"
}]
</source>

After the first step, the internal state will be:

<source lang="js">
[1,2,3]
</source>

After the second step, the number 4 will be pushed to the end of the array:

<source lang="js">
[1,2,3,4]
</source>

After the third step, the number 0 will be added to the start of the array:

<source lang="js">
[0,1,2,3,4]
</source>

The last step will revert the value of focus to the initial object:

<source lang="js">
{
"a": [0,1,2,3,4]
}
</source>

=== IMPORT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/data/test2.json</code>:

<source lang="js">
{
"b": {
"a": 2
},
"c": {
"a": 3
},
"d": 4
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "IMPORT",
"src": "data/test2.json"
}]
</source>

This is equivalent to:

<source lang="js">
[{
"type": "IMPORT",
"src": "game:data/test2.json"
}]
</source>

The first step would load <code>assets/data/test2.json</code> then merge it with the current value resulting in this:

<source lang="js">
{
"a": {
"b": 2
},
"b": {
"a": 2
},
,
"c": {
"a": 3
},
"d": 4
}
</source>

If <code>assets/data/test2.json</code> had patches associated with it, it would be applied before being merged.

Another feature is loading json files inside the mod directory and merging. No patches to the loaded file will be done if <code>mod:</code> is specified.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "IMPORT",
"src": "mod:patches/data/test.json",
"path": ["1", "2", "3"],
"index": "y"
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

First it will load <code>assets/mods/my-mod/patches/data/test.json</code>.

Then it will walk the path specified.

Initial loaded file internal representation:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

After entering "1":

<source lang="js">
{
"2": {
"3": 4
}
}
</source>

After entering "2":

<source lang="js">
{
"3": 4
}
</source>

After entering "3":

<source lang="js">
4
</source>

Finally, it will add a key "y" with the value that resulted from the path walk (4).

So the overall result will be:

<source lang="js">
{
"a": {
"b": 2
},
"y": 4
}
</source>

Note: "index" and "path" options are optional.

=== INCLUDE ===

The purpose of <code>INCLUDE</code> is to allow external Object Patching or PatchSteps to be performed.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

This is like setting the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

However, <code>INCLUDE</code> is used as an organization method.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}, {
"type": "SET_KEY",
"index": "b",
"content": [1,2,3]
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
[{
"type": "ENTER",
"index": ["a"]
}]
</source>

This results in:

<source lang="js">
{
"a": {
"b": 2
},
"b": [1,2,3]
}
</source>

Think of PatchStep files as its own room. What include does is generate a new room to perform some special operation. Rooms do not intefere with each other, they just modify the data.

=== FOR_IN ===

This PatchStep is useful for combining repeated set of PatchSteps with only slightly variations in input.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__INDEX__",
"values": [1,2,3,4],
"body": [{
"type": "SET_KEY",
"index": "__INDEX__-id",
"content": "__INDEX__"
}]
}]
</source>

This results in:

<source lang="js">
{
"1-id": "1",
"2-id": "2",
"3-id": "3",
"4-id": "4"
}
</source>

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": {
"name": "__NAME__",
"id": "__ID__"
},
"values": [{
"name": "Bob",
"id": 1
},{
"name": "Joe",
"id": 2
}],
"body": [{
"type": "SET_KEY",
"index": "__NAME__",
"content": "__ID__"
}]
}]
</source>

This results in:

<source lang="js">
{
"Bob": "1",
"Joe": "2"
}
</source>

=== COPY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__",
}, {
"type": "EXIT"
}]
}]
</source>

Nothing will change. All this will do is create an internal key-value storage that looks like this:

{ "alias-a": 2, "alias-b": [3], "alias-c": { "d": 4 } }

=== MERGE_CONTENT ===

With the following data:

<source lang="js">
{
"a": 1,
"b": 2
}
</source>

And the following patch step:

<source lang="js">
{
"type": "MERGE_CONTENT",
"content": {
"a": 3,
"c": 4
}
}
</source>

<code>MERGE_CONTENT</code> would modify the data to be:

<source lang="js">
{
"a": 3,
"b": 2,
"c": 4
}
</source>

For an array, it would work the same way - effectively acting as multiple <code>ADD_ARRAY_ELEMENT</code> steps being executed at the end of the array.

=== PASTE ===

This command relies on COPY.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__"
},{
"type": "EXIT"
},{
"type": "SET_KEY",
"index": "__VAR__"
}]
}, {
"type": "SET_KEY",
"index": "saved",
"content": {}
}, {
"type": "ENTER",
"index": "saved"
}, {
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "PASTE",
"alias": "alias-__VAR__",
"index": "__VAR__"
}]
}]
</source>

This is the result:

<source lang="js">
{
"saved": {
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
}
</source>

=== CALL ===

This step allows you to call a custom step.

First, you define a custom step. In a CCLoader2 mod:

<source lang="js">
// NOTE: This MUST be done BEFORE prestart! That being: plugin, preload, postload
simplifyResources.patchSteps.callable.register("YOUR_ID", (state, args) => {
console.log(args);
});
</source>

Then, in your patch file:
<source lang="js">
[{
"type": "CALL",
"id": "YOUR_ID",
"args": {
"someArg": 1
}
}]
</source>

This would log <code>{ someArg: 1 }</code> to the console whenever the step is called.

If you think patch steps are lacking in some way, <code>CALL</code> allows you to define your own steps that process your args in some way without having to contribute back to the library.

=== DEBUG ===

<source lang="js">
[{
"type": "DEBUG",
"value": true
}, {
"type": "DEBUG",
"value": false
}]
</source>

This PatchStep turns Debug Mode on or off.

=== COMMENT ===

Debug mode must be on for this PatchStep to work.

<source lang="js">
[{
"type": "DEBUG",
"value": true
},{
"type": "COMMENT",
"value": "This is a comment"
}, {
"type": "COMMENT",
"value": {
"data": 3
}
}]
</source>

This will first display <code>This is a comment</code> in the DevTools console. It will then display <code>{data: 3}</code>.

[[Category:Modding guides]]

Installing mods

2023-04-07T08:19:18Z

Lexisother: Also explain installation of .ccmod files

This guide describes the most common way of installation of perfectly regular CrossCode mods. Granted, not every mod is equal, some may require additional setup before or after installation, but that must be described in mod's README document. If not - well, this is most likely the mod author's problem. Note that you don't have to read this guide each time you download a new mod as this page is intended for absolute beginners.

=== Short note about upgrading mods ===

You '''can''' perform mod upgrades by performing the steps described in this guide, but replacing all previous files when unpacking the downloaded mod. However, '''this is not recommended''' (by me at least) - instead you should first delete the folder with the previous version of the mod you are upgrading and only then unpack the new version, just in case.

== Step 1. Install [[CCLoader]] ==

CCLoader (aka the '''C'''ross'''C'''ode mod'''loader''') is required for most mods nowadays to work. Well, it is possible to <s>ab</s>use the DLC/extension system for creating simple asset swaps, but these are its limits - it's ''definitely'' not designed for full-fledged modding. CCLoader also provides various tooling for mod authors for selectively patching game content, so that mod authors can put just the changed bits of game files in their mods instead of copying them entirely. The guide about CCLoader installation can be found [[CCLoader#Installation|here]].

== Step 2. Get the mod files ==

Most mods are distributed as zip archives. There are two ways to obtain those:

=== Downloading releases ===

''See also [[CCLoader#VERY IMPORTANT NOTE: Don't use the green "clone or download" button!|this section]] of the CCLoader installation guide''

Unless explicitly stated otherwise in the mod's README, '''when actually downloading mods you should always check first for released versions''', or "releases" for short. Most mod authors use GitHub for storing source code and distributing releases where you can access the page with changelogs and downloads through these links:

[[File:Github-mod-releases.png|class=block-img]]

Pressing on the version marked as "latest" will take you to, unsurprisingly, the page of the latest release, pressing on the <code>Releases (N)</code> or <code>+N releases</code> links at the top and bottom (where <code>N</code> is some number) will take you to a list of all available versions. Mods also often include the following badge in their README which takes you directly to downloads:

[https://raw.githubusercontent.com/CCDirectLink/organization/master/assets/badges/releases@2x.png https://raw.githubusercontent.com/CCDirectLink/organization/master/assets/badges/releases@2x.png]

On the release page you'll see the section named "Assets". It always includes at least two entries: "Source code (zip)" and "Source code (tar.gz)". If only links for downloading source code are present - don't worry, you can use those to install the mod. Just download whichever archive format you prefer. Otherwise mod authors upload at least zip archives on the downloads page, usually the file name of those includes the mod ID and version.

=== Downloading source code ===

Most of the time mod authors publish the releases properly, but when the "releases" page is empty or the link is hidden it can mean one of three things:

# The project is dead.
# The mod is work-in-progress project, or WIP for short. Such mods usually don't have a proper README file. In this case you should contact the author to ask if the mod is usable. You can also potentially help with the development - sometimes mods may need testers.
# The author was just lazy to publish releases properly. Most mods don't require compilation or preprocessing of assets or scripts to be loaded into the game and work, so in such cases you can try to download the mod's source code. On GitHub this can be done by pressing the green "code" button with a download icon to the left, and then pressing "download ZIP" in the opened popup:<br>[[File:Mod-download-source-code.png|class=block-img]]

'''Beware, however, that sometimes the source code of mods is structured in a weird way''', mostly in mods made by ac2pic aka Emileyah, so sometimes you can't just put files of the downloaded archive into your mods folder and call it a day. As a rule of thumb, a folder which contains a file named <code>ccmod.json</code> is most likely a mod. In the case of ac2pic's mods, the mod is usually located in a subfolder named similarly to the mod itself.

== Step 3. Unpack the downloaded mod into your mods folder ==

The title of this step is a bit misleading, because depending on the type of mod you downloaded, you may not even have to extract it.

To locate your mods folder you first need to find the [[Locations of CrossCode files#Game files folder|CrossCode game files folder]], then go to <code>assets</code>, then <code>mods</code>. If the folder <code>mods</code> doesn't exist - create it.

=== Is your mod a <code>.ccmod</code> file? ===

Worry not! All you have to do is move the file into the <code>mods</code> folder.

=== Is your mod a <code>.zip</code> file? ===

Unpack the mod folder contained in the archive you downloaded there. Be sure to put the mod folder in <code>mods</code>, not the files inside because '''each mod lives in its own separate folder'''! You can also ensure that the folder you unpacked contains a file named <code>ccmod.json</code>.

[[File:Mods-dir-structure-separate-folders.png]]

'''NOTE:''' these screenshots are a bit outdated (TODO update, include multiple mods to better demonstrate the idea), for example because they doesn't contain <code>ccmod.json</code>, but I hope you get the correct idea.

== Step 4. PROFIT!!! ==

This basically concludes installation of perfectly regular mods.

== Common mod installation problems ==

=== "Problem with requirements of mod" errors are printed and the mod isn't loaded ===

Some mods work only on certain versions of CrossCode or CCLoader and some mods require other mods to function (so-called libraries). If these requirements of a given mod aren't met when the game is loaded, the modloader will simply skip this mod and proceed to start the game without it.

{| class="wikitable"
!width="25%"| Requirement problem
!width="75%"| Explanation
|-
| <code>mod 'xyz' is not installed</code>
| The mod <code>xyz</code> is a so-called "dependency" of the mod you installed and you should install it as well. Usually dependencies are listed in the mod's README.
|-
| <code>mod 'xyz' is disabled</code>
| Unsurprisingly, you have to enable the mod <code>xyz</code> to get the installed mod working.
|-
| <code>mod 'xyz' is not loaded</code>
| If there is a problem in the chain of dependencies, then all mods in that chain aren't loaded. See the error which caused <code>xyz</code> to not be loaded.
|-
| <code>version of xyz is not in range abc</code>
| The installed mod is compatible with a specific range of versions of <code>xyz</code>, try downgrading or upgrading <code>xyz</code>.
|-
| <code>mod 'xyz' doesn't have a version</code>
| The developer of the mod you are installing likely made a mistake or you downloaded a very old development version of <code>xyz</code>.
|}

[[Category:Guides for mod users]]

2767mr's code pearls

2022-10-01T12:22:50Z

Lexisother: Add the game ratio pearl

A simple hello world mod:

<syntaxhighlight lang="javascript">
export default class HelloWorld extends Plugin {
prestart() {
console.log('Hello world!');
}
}
</syntaxhighlight>

How to get your mod directory:

<syntaxhighlight lang="javascript">
export default class ModFolder extends Plugin {
constructor(mod) {
this.dir = mod.baseDirectory;
}
prestart() {
console.log(`Your mod directory is ${this.dir}`);
}
}
</syntaxhighlight>

Check if code is running in the browser:

<syntaxhighlight lang="javascript">
ig.platform === ig.PLATFORM_TYPES.BROWSER
</syntaxhighlight>

Double all CP gain:

<syntaxhighlight lang="javascript">
sc.PlayerModel.inject({
addSkillPoints(points, element, all, extra) {
this.parent(points*2, element, all, extra);
}
});
</syntaxhighlight>

Register preupdate calls:

<syntaxhighlight lang="javascript">
export default class UpdateCall extends Plugin {
prestart() {
const self = this;
sc.CrossCode.inject({
init(...args) {
this.parent(...args);
this.addons.preUpdate.push(self);
}
})
}
onPreUpdate() {
//...
}
}
</syntaxhighlight>

Enable new game+ early:

<syntaxhighlight lang="javascript">
sc.TitleScreenButtonGui.inject({
checkClearSaveFiles: function() {
return true;
}
});
</syntaxhighlight>

Open devtools for a background page:

<syntaxhighlight lang="javascript">
chrome.developerPrivate.openDevTools({
renderViewId: -1,
renderProcessId: -1,
extensionId: chrome.runtime.id
});
</syntaxhighlight>

Instant respawn for enemies:

<syntaxhighlight lang="javascript">
ig.ENTITY.EnemySpawner.inject({
update(...args) {
this.respawnTimer = 0;
return this.parent(...args);
}
});
</syntaxhighlight>

A lot of trophy points:

<syntaxhighlight lang="javascript">
sc.TrophyManager.inject({
getTotalPoints() {
return 100000000;
}
});
</syntaxhighlight>

Enables witch times for all controlled characters:

<syntaxhighlight lang="javascript">
ig.ENTITY.Player.inject({
onPerfectDash() {
this.parent();
if (!this.dashPerfect && this.model.name != "Lea"
&& this.model.name == sc.model.player.name && sc.newgame.get("witch-time") && !ig.vars.get("tmp.slowMotionActive")) {
sc.combat.showPerfectDashEffect(this);
const proxy = sc.ProxyTools.getProxy("evadeSloMo", this);
if (proxy)
proxy.spawn(this.coll.pos.x, this.coll.pos.y, this.coll.pos.z, this, this.face, true);
this.invincibleTimer = 4;
}
}
});
</syntaxhighlight>

Changes game ratio from 16:9 to 21:9:

<syntaxhighlight lang="javascript">
export default class Widescreen {
prestart() {
const factor = 21 / 16;
window.IG_WIDTH *= factor;
}
}
</syntaxhighlight>

Patching

2022-10-01T12:04:54Z

Lexisother: Add MERGE_CONTENT step

<big>'''NOTE:''' This article needs editing!!!</big>

= What is patching? =

In the scope modding, patching is changing the original game content in any way.

= How do I patch game files? =

There is more than one way to patch the game. This page will walk you through the various ways to patch.

<hr>

= Asset Replacement =

This is the most basic type of patching (anyone can do it).

This is a standard modloader feature that allows you to replace any file the game loads with your own.

== Process ==

Inside your mod folder, create a folder called <code>assets</code>.

[[File:Mod-assets-folder.png|class=block-img]]

Decide what file you want to replace. For this tutorial, I will be showing you how to replace Lea's portraits.

Find the original relative path to asset of interest.

[[File:Lea-face-path.png|class=block-img]]

All you have to do is now mimic the folder structure.

In this example, two folders need to be created.

Inside the <code>assets</code> folder in your mod, create a <code>media</code> folder. Inside the <code>media</code> folder, create a <code>face</code> folder.

Finally, add the file you want to replace (your own <code>lea.png</code>).

It should end up looking something like this.

[[File:Faceless-mod-path-example.png|class=block-img]]

[[File:Faceless-mod-folder-contents-example.png|class=block-img]]

That is it!

You can find more examples in the [[github:CCDirectLink/CCAssetSwaps]] repo.

* Used faceless Lea mod for some of the demonstration

= JSON Patching (Object Patching) =

Note: This requires some know of the JSON format and some programming concepts

As the majority of the game assets are json files, this is really useful to know about.

What this allows you to do is modify any json file without doing a file replacement.

The same ideas apply as assets override, except the file will have <code>.patch</code> added to the full file name.

You need to have file extensions visible in order to modify it.

== Process ==

Let's say you want to patch a file <code>assets/data/test.json</code> with this as the contents:

<source lang="js">
{
"storage" : {
"level": 100,
"xp": 500
}
}
</source>

Your mod is located at <code>assets/mods/my-mod/</code>

You would create a file with the filepath <code>assets/mods/my-mod/assets/data/test.json.patch</code>

To replace "storage.level" with 200, <code>test.json.patch</code> would look like this:

<source lang="js">
{
"storage" : {
"level": 200
}
}
</source>

To add "storage.name":

<source lang="js">
{
"storage" : {
"name": "Shizuka"
}
}
</source>

Object patching is useful for adding new properties and modifying existing ones.

Weakness: - Inability to removal properties - Arrays are hard to patch

= Patch Steps =

Patch Steps is another way to perform json file Patching. It is more powerful than Object Patching.

The only difference between Object Patching and Patch Steps is the format of the <code>.patch</code> file.

We will be using the same sample json file used to demonstrate how Object Patching works.

Location: <code>assets/data/test.json</code>

<source lang="js">
{
"storage" : {
"level": 200
}
}
</source>

== Appliers ==

An Applier is a Patch Step command.

== Patch Step Appliers ==

<source lang="js"></source>

=== ENTER ===

This changes the context of a patch.

<source lang="js">
[{
"type": "ENTER",
"index": ["storage"]
}]
</source>

or

<source lang="js">
[{
"type": "ENTER",
"index": "storage"
}]
</source>

would change the internal view of:

<source lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</source>

to

<source lang="js">
{
"level": 200,
"saves": [{
"data": "blob"
}]
}
</source>

<source lang="js">
[{
"type": "ENTER",
"index": ["storage", "saves", 0]
}]
</source>

would change the internal view of:

<source lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</source>

to

<source lang="js">
{
"data": "blob"
}
</source>

=== EXIT ===

For every <code>ENTER</code>, there should be at least one <code>EXIT</code>.

<code>EXIT</code> undos an <code>ENTER</code>.

<source lang="js">
[{
"type": "EXIT"
}]
</source>

is equivalent to

<source lang="js">
[{
"type": "EXIT",
"count": 1
}]
</source>

For demonstration purposes, this is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

and this is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "ENTER",
"index": ["storage", "user"]
}, {
"type": "EXIT",
"count": 2
}]
</source>

The first step will produce the internal result of:

<source lang="js">
{
"name": 20
}
</source>

The second step will undo the first leading to the initial state.

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

=== SET_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "SET_KEY",
"index": "storage"
}]
</source>

This is the result:

<source lang="js">
{}
</source>

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "SET_KEY",
"index": "storage",
"content": 2
}]
</source>

This is the result:

<source lang="js">
{
"storage": 2
}
</source>

=== INIT_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INIT_KEY",
"index": "storage",
"content": {
"a": 2
}
}]
</source>

Nothing will change to the data because "storage" already exists.

Changing <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<source lang="js">
[{
"type": "INIT_KEY",
"index": "storage2",
"content": {
"a": 2
}
}]
</source>

would result in:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
},
"storage2": {
"a": 2
}
}
</source>

=== REMOVE_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": [1,2,3]
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "REMOVE_ARRAY_ELEMENT",
"index": 0
}]
</source>

Applying the patch will result in this:

<source lang="js">
{
"a": [2,3]
}
</source>

=== ADD_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": [1,2,3]
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "ENTER",
"index": "a"
},{
"type": "ADD_ARRAY_ELEMENT",
"content": 4
}, {
"type": "ADD_ARRAY_ELEMENT",
"index": 0,
"content": 0
}, {
"type": "EXIT"
}]
</source>

After the first step, the internal state will be:

<source lang="js">
[1,2,3]
</source>

After the second step, the number 4 will be pushed to the end of the array:

<source lang="js">
[1,2,3,4]
</source>

After the third step, the number 0 will be added to the start of the array:

<source lang="js">
[0,1,2,3,4]
</source>

The last step will revert the value of focus to the initial object:

<source lang="js">
{
"a": [0,1,2,3,4]
}
</source>

=== IMPORT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/data/test2.json</code>:

<source lang="js">
{
"b": {
"a": 2
},
"c": {
"a": 3
},
"d": 4
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "IMPORT",
"src": "data/test2.json"
}]
</source>

This is equivalent to:

<source lang="js">
[{
"type": "IMPORT",
"src": "game:data/test2.json"
}]
</source>

The first step would load <code>assets/data/test2.json</code> then merge it with the current value resulting in this:

<source lang="js">
{
"a": {
"b": 2
},
"b": {
"a": 2
},
,
"c": {
"a": 3
},
"d": 4
}
</source>

If <code>assets/data/test2.json</code> had patches associated with it, it would be applied before being merged.

Another feature is loading json files inside the mod directory and merging. No patches to the loaded file will be done if <code>mod:</code> is specified.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "IMPORT",
"src": "mod:patches/data/test.json",
"path": ["1", "2", "3"],
"index": "y"
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

First it will load <code>assets/mods/my-mod/patches/data/test.json</code>.

Then it will walk the path specified.

Initial loaded file internal representation:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

After entering "1":

<source lang="js">
{
"2": {
"3": 4
}
}
</source>

After entering "2":

<source lang="js">
{
"3": 4
}
</source>

After entering "3":

<source lang="js">
4
</source>

Finally, it will add a key "y" with the value that resulted from the path walk (4).

So the overall result will be:

<source lang="js">
{
"a": {
"b": 2
},
"y": 4
}
</source>

Note: "index" and "path" options are optional.

=== INCLUDE ===

The purpose of <code>INCLUDE</code> is to allow external Object Patching or PatchSteps to be performed.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

This is like setting the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

However, <code>INCLUDE</code> is used as an organization method.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}, {
"type": "SET_KEY",
"index": "b",
"content": [1,2,3]
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
[{
"type": "ENTER",
"index": ["a"]
}]
</source>

This results in:

<source lang="js">
{
"a": {
"b": 2
},
"b": [1,2,3]
}
</source>

Think of PatchStep files as its own room. What include does is generate a new room to perform some special operation. Rooms do not intefere with each other, they just modify the data.

=== FOR_IN ===

This PatchStep is useful for combining repeated set of PatchSteps with only slightly variations in input.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__INDEX__",
"values": [1,2,3,4],
"body": [{
"type": "SET_KEY",
"index": "__INDEX__-id",
"content": "__INDEX__"
}]
}]
</source>

This results in:

<source lang="js">
{
"1-id": "1",
"2-id": "2",
"3-id": "3",
"4-id": "4"
}
</source>

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": {
"name": "__NAME__",
"id": "__ID__"
},
"values": [{
"name": "Bob",
"id": 1
},{
"name": "Joe",
"id": 2
}],
"body": [{
"type": "SET_KEY",
"index": "__NAME__",
"content": "__ID__"
}]
}]
</source>

This results in:

<source lang="js">
{
"Bob": "1",
"Joe": "2"
}
</source>

=== COPY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__",
}, {
"type": "EXIT"
}]
}]
</source>

Nothing will change. All this will do is create an internal key-value storage that looks like this:

{ "alias-a": 2, "alias-b": [3], "alias-c": { "d": 4 } }

=== MERGE_CONTENT ===

With the following data:

<source lang="js">
{
"a": 1,
"b": 2
}
</source>

And the following patch step:

<source lang="js">
{
"type": "MERGE_CONTENT",
"content": {
"a": 3,
"c": 4
}
}
</source>

<code>MERGE_CONTENT</code> would modify the data to be:

<source lang="js">
{
"a": 3,
"b": 2,
"c": 4
}
</source>

For an array, it would work the same way - effectively acting as multiple <code>ADD_ARRAY_ELEMENT</code> steps being executed at the end of the array.

=== PASTE ===

This command relies on COPY.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__"
},{
"type": "EXIT"
},{
"type": "SET_KEY",
"index": "__VAR__"
}]
}, {
"type": "SET_KEY",
"index": "saved",
"content": {}
}, {
"type": "ENTER",
"index": "saved"
}, {
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "PASTE",
"alias": "alias-__VAR__",
"index": "__VAR__"
}]
}]
</source>

This is the result:

<source lang="js">
{
"saved": {
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
}
</source>

=== DEBUG ===

<source lang="js">
[{
"type": "DEBUG",
"value": true
}, {
"type": "DEBUG",
"value": false
}]
</source>

This PatchStep turns Debug Mode on or off.

=== COMMENT ===

Debug mode must be on for this PatchStep to work.

<source lang="js">
[{
"type": "DEBUG",
"value": true
},{
"type": "COMMENT",
"value": "This is a comment"
}, {
"type": "COMMENT",
"value": {
"data": 3
}
}]
</source>

This will first display <code>This is a comment</code> in the DevTools console. It will then display <code>{data: 3}</code>.

[[Category:Modding guides]]

Patching

2022-10-01T11:59:05Z

Lexisother: Capitalize all step names

<big>'''NOTE:''' This article needs editing!!!</big>

= What is patching? =

In the scope modding, patching is changing the original game content in any way.

= How do I patch game files? =

There is more than one way to patch the game. This page will walk you through the various ways to patch.

<hr>

= Asset Replacement =

This is the most basic type of patching (anyone can do it).

This is a standard modloader feature that allows you to replace any file the game loads with your own.

== Process ==

Inside your mod folder, create a folder called <code>assets</code>.

[[File:Mod-assets-folder.png|class=block-img]]

Decide what file you want to replace. For this tutorial, I will be showing you how to replace Lea's portraits.

Find the original relative path to asset of interest.

[[File:Lea-face-path.png|class=block-img]]

All you have to do is now mimic the folder structure.

In this example, two folders need to be created.

Inside the <code>assets</code> folder in your mod, create a <code>media</code> folder. Inside the <code>media</code> folder, create a <code>face</code> folder.

Finally, add the file you want to replace (your own <code>lea.png</code>).

It should end up looking something like this.

[[File:Faceless-mod-path-example.png|class=block-img]]

[[File:Faceless-mod-folder-contents-example.png|class=block-img]]

That is it!

You can find more examples in the [[github:CCDirectLink/CCAssetSwaps]] repo.

* Used faceless Lea mod for some of the demonstration

= JSON Patching (Object Patching) =

Note: This requires some know of the JSON format and some programming concepts

As the majority of the game assets are json files, this is really useful to know about.

What this allows you to do is modify any json file without doing a file replacement.

The same ideas apply as assets override, except the file will have <code>.patch</code> added to the full file name.

You need to have file extensions visible in order to modify it.

== Process ==

Let's say you want to patch a file <code>assets/data/test.json</code> with this as the contents:

<source lang="js">
{
"storage" : {
"level": 100,
"xp": 500
}
}
</source>

Your mod is located at <code>assets/mods/my-mod/</code>

You would create a file with the filepath <code>assets/mods/my-mod/assets/data/test.json.patch</code>

To replace "storage.level" with 200, <code>test.json.patch</code> would look like this:

<source lang="js">
{
"storage" : {
"level": 200
}
}
</source>

To add "storage.name":

<source lang="js">
{
"storage" : {
"name": "Shizuka"
}
}
</source>

Object patching is useful for adding new properties and modifying existing ones.

Weakness: - Inability to removal properties - Arrays are hard to patch

= Patch Steps =

Patch Steps is another way to perform json file Patching. It is more powerful than Object Patching.

The only difference between Object Patching and Patch Steps is the format of the <code>.patch</code> file.

We will be using the same sample json file used to demonstrate how Object Patching works.

Location: <code>assets/data/test.json</code>

<source lang="js">
{
"storage" : {
"level": 200
}
}
</source>

== Appliers ==

An Applier is a Patch Step command.

== Patch Step Appliers ==

<source lang="js"></source>

=== ENTER ===

This changes the context of a patch.

<source lang="js">
[{
"type": "ENTER",
"index": ["storage"]
}]
</source>

or

<source lang="js">
[{
"type": "ENTER",
"index": "storage"
}]
</source>

would change the internal view of:

<source lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</source>

to

<source lang="js">
{
"level": 200,
"saves": [{
"data": "blob"
}]
}
</source>

<source lang="js">
[{
"type": "ENTER",
"index": ["storage", "saves", 0]
}]
</source>

would change the internal view of:

<source lang="js">
{
"storage" : {
"level": 200,
"saves": [{
"data": "blob"
}]
}
}
</source>

to

<source lang="js">
{
"data": "blob"
}
</source>

=== EXIT ===

For every <code>ENTER</code>, there should be at least one <code>EXIT</code>.

<code>EXIT</code> undos an <code>ENTER</code>.

<source lang="js">
[{
"type": "EXIT"
}]
</source>

is equivalent to

<source lang="js">
[{
"type": "EXIT",
"count": 1
}]
</source>

For demonstration purposes, this is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

and this is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "ENTER",
"index": ["storage", "user"]
}, {
"type": "EXIT",
"count": 2
}]
</source>

The first step will produce the internal result of:

<source lang="js">
{
"name": 20
}
</source>

The second step will undo the first leading to the initial state.

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

=== SET_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "SET_KEY",
"index": "storage"
}]
</source>

This is the result:

<source lang="js">
{}
</source>

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "SET_KEY",
"index": "storage",
"content": 2
}]
</source>

This is the result:

<source lang="js">
{
"storage": 2
}
</source>

=== INIT_KEY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INIT_KEY",
"index": "storage",
"content": {
"a": 2
}
}]
</source>

Nothing will change to the data because "storage" already exists.

Changing <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<source lang="js">
[{
"type": "INIT_KEY",
"index": "storage2",
"content": {
"a": 2
}
}]
</source>

would result in:

<source lang="js">
{
"storage": {
"user": {
"name": 20
}
},
"storage2": {
"a": 2
}
}
</source>

=== REMOVE_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": [1,2,3]
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "REMOVE_ARRAY_ELEMENT",
"index": 0
}]
</source>

Applying the patch will result in this:

<source lang="js">
{
"a": [2,3]
}
</source>

=== ADD_ARRAY_ELEMENT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": [1,2,3]
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "ENTER",
"index": "a"
},{
"type": "ADD_ARRAY_ELEMENT",
"content": 4
}, {
"type": "ADD_ARRAY_ELEMENT",
"index": 0,
"content": 0
}, {
"type": "EXIT"
}]
</source>

After the first step, the internal state will be:

<source lang="js">
[1,2,3]
</source>

After the second step, the number 4 will be pushed to the end of the array:

<source lang="js">
[1,2,3,4]
</source>

After the third step, the number 0 will be added to the start of the array:

<source lang="js">
[0,1,2,3,4]
</source>

The last step will revert the value of focus to the initial object:

<source lang="js">
{
"a": [0,1,2,3,4]
}
</source>

=== IMPORT ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/data/test2.json</code>:

<source lang="js">
{
"b": {
"a": 2
},
"c": {
"a": 3
},
"d": 4
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "IMPORT",
"src": "data/test2.json"
}]
</source>

This is equivalent to:

<source lang="js">
[{
"type": "IMPORT",
"src": "game:data/test2.json"
}]
</source>

The first step would load <code>assets/data/test2.json</code> then merge it with the current value resulting in this:

<source lang="js">
{
"a": {
"b": 2
},
"b": {
"a": 2
},
,
"c": {
"a": 3
},
"d": 4
}
</source>

If <code>assets/data/test2.json</code> had patches associated with it, it would be applied before being merged.

Another feature is loading json files inside the mod directory and merging. No patches to the loaded file will be done if <code>mod:</code> is specified.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "IMPORT",
"src": "mod:patches/data/test.json",
"path": ["1", "2", "3"],
"index": "y"
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

First it will load <code>assets/mods/my-mod/patches/data/test.json</code>.

Then it will walk the path specified.

Initial loaded file internal representation:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

After entering "1":

<source lang="js">
{
"2": {
"3": 4
}
}
</source>

After entering "2":

<source lang="js">
{
"3": 4
}
</source>

After entering "3":

<source lang="js">
4
</source>

Finally, it will add a key "y" with the value that resulted from the path walk (4).

So the overall result will be:

<source lang="js">
{
"a": {
"b": 2
},
"y": 4
}
</source>

Note: "index" and "path" options are optional.

=== INCLUDE ===

The purpose of <code>INCLUDE</code> is to allow external Object Patching or PatchSteps to be performed.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

This is like setting the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code> to:

<source lang="js">
{
"1": {
"2": {
"3": 4
}
}
}
</source>

However, <code>INCLUDE</code> is used as an organization method.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": {
"b": 2
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "INCLUDE",
"src": "mod:patches/data/test.json",
}, {
"type": "SET_KEY",
"index": "b",
"content": [1,2,3]
}]
</source>

This is the contents of <code>assets/mods/my-mod/patches/data/test.json</code>:

<source lang="js">
[{
"type": "ENTER",
"index": ["a"]
}]
</source>

This results in:

<source lang="js">
{
"a": {
"b": 2
},
"b": [1,2,3]
}
</source>

Think of PatchStep files as its own room. What include does is generate a new room to perform some special operation. Rooms do not intefere with each other, they just modify the data.

=== FOR_IN ===

This PatchStep is useful for combining repeated set of PatchSteps with only slightly variations in input.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__INDEX__",
"values": [1,2,3,4],
"body": [{
"type": "SET_KEY",
"index": "__INDEX__-id",
"content": "__INDEX__"
}]
}]
</source>

This results in:

<source lang="js">
{
"1-id": "1",
"2-id": "2",
"3-id": "3",
"4-id": "4"
}
</source>

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": {
"name": "__NAME__",
"id": "__ID__"
},
"values": [{
"name": "Bob",
"id": 1
},{
"name": "Joe",
"id": 2
}],
"body": [{
"type": "SET_KEY",
"index": "__NAME__",
"content": "__ID__"
}]
}]
</source>

This results in:

<source lang="js">
{
"Bob": "1",
"Joe": "2"
}
</source>

=== COPY ===

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__",
}, {
"type": "EXIT"
}]
}]
</source>

Nothing will change. All this will do is create an internal key-value storage that looks like this:

{ "alias-a": 2, "alias-b": [3], "alias-c": { "d": 4 } }

=== PASTE ===

This command relies on COPY.

This is the contents of <code>assets/data/test.json</code>:

<source lang="js">
{
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
</source>

This is the contents of <code>assets/mods/my-mod/assets/data/test.json.patch</code>:

<source lang="js">
[{
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "ENTER",
"index": "__VAR__"
},{
"type": "COPY",
"alias": "alias-__VAR__"
},{
"type": "EXIT"
},{
"type": "SET_KEY",
"index": "__VAR__"
}]
}, {
"type": "SET_KEY",
"index": "saved",
"content": {}
}, {
"type": "ENTER",
"index": "saved"
}, {
"type": "FOR_IN",
"keyword": "__VAR__",
"values": ["a", "b", "c"],
"body": [{
"type": "PASTE",
"alias": "alias-__VAR__",
"index": "__VAR__"
}]
}]
</source>

This is the result:

<source lang="js">
{
"saved": {
"a": 2,
"b": [3],
"c": {
"d": 4
}
}
}
</source>

=== DEBUG ===

<source lang="js">
[{
"type": "DEBUG",
"value": true
}, {
"type": "DEBUG",
"value": false
}]
</source>

This PatchStep turns Debug Mode on or off.

=== COMMENT ===

Debug mode must be on for this PatchStep to work.

<source lang="js">
[{
"type": "DEBUG",
"value": true
},{
"type": "COMMENT",
"value": "This is a comment"
}, {
"type": "COMMENT",
"value": {
"data": 3
}
}]
</source>

This will first display <code>This is a comment</code> in the DevTools console. It will then display <code>{data: 3}</code>.

[[Category:Modding guides]]