CCDirectLink - User contributions [en]

CCLoader

2021-10-10T11:50:55Z

Dmitmel: Remove info about v3 until it is released

'''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: [[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this: [[File:Ccloader-quick-install.png|class=block-img]] The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>: [[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): [[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:

<source 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 -</source>

=== 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]]

2767mr's code pearls

2021-08-14T15:56:22Z

Dmitmel: Created page with "A simple hello world mod: <syntaxhighlight lang="javascript"> export default class HelloWorld extends Plugin { prestart() { console.log('Hello world!'); } } </syntaxh..."

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>

Ccmod.json

2021-03-08T17:59:19Z

Dmitmel: Created page with "{{Lowercase title}}"

CrossCode Modding Tutorial

2021-01-26T18:40:18Z

Dmitmel: fix the mentioned nw.js version

This page contains the steps on how to create your very first CrossCode mod. (header WIP, ask 2767mr)

= Installing CCLoader =

⚠ '''Due to DRM it is not possible to mod Xbox Game Pass or Microsoft Store versions of the game.'''

See [[CCLoader#Installation]]

= Installing NW.js =

== Requirements ==

* [[Locations_of_CrossCode_files#Game_files_folder|CC installation folder]]
* [https://nwjs.io NW.js SDK zip]

⚠ '''The game uses an outdated version of NW.js, so you might want to use version <code>0.35.5</code> to avoid accidentally using features not yet available in CrossCode.'''

== Steps ==

# Open the nwjs-sdk zip
# Open the folder so you can see the <code>nw.exe</code> file

[[File:nwjsRoot.png|class=block-img]]

# <li value=3>Extract/drag all files into the [[Locations_of_CrossCode_files#Game_files_folder|CC installation folder]] and replace existing files when prompted.</li>
# Delete <code>CrossCode.exe</code>
# Rename <code>nw.exe</code> to <code>CrossCode.exe</code>
# Open the game
# Press F12 to open the Chrome DevTools
# Click the <code>Console</code> tab
# In the top bar, click <code>top</code>
# Choose the second entry in the dropdown list
# You can now enter commands into the console

= Making a mod =

== Requirements ==

* [[CCLoader#Installation|Installing CCLoader]]
* [[Locations_of_CrossCode_files#Game_files_folder|CC installation folder]]

== Steps ==

# Open the [[Locations_of_CrossCode_files#Game_files_folder|CC installation folder]]
# Open <code>assets</code> -> <code>mods</code>
# Create a new folder for your mod. In this example, we are going to use <code>myMod</code>
# Create a new file called <code>package.json</code>

This file is used to tell CCLoader how to load your mod. It contains the internal name (<code>name</code>), the in-game displayed name (<code>ccmodHumanName</code>), the version number (<code>version</code>) and dependencies (<code>ccmodDependencies</code>). Only <code>name</code> and <code>version</code> are required.

=== Example <code>package.json</code> ===

<syntaxhighlight lang="json" line="line">
{
"name": "my-mod",
"ccmodHumanName": "My Mod",
"version": "1.0.0"
}
</syntaxhighlight>

# <li value=5>Find a file to modify</li>

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

# <li value=6>Copy the file to your mod</li>

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

⚠ '''Do not publish original CrossCode files in your mod.'''

# <li value=7>Edit the file</li>

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

[[File:leaRecolor.png|class=block-img]]

# <li value=8>Restart the game and test your mod</li>

[[File:leaRecolored.png|class=block-img]]

= Editing JSON =

Often it is not enough to just edit png files to make mods. Changing sizes, making new entities or maps require one to edit or create new JSON files. This guide shows you how to work with JSON files in your mod.

== Requirements ==

* [[CrossCode Modding Tutorial#Making a mod|Making a mod]]

== New JSON files ==

Adding new JSON files does not require any special attention. Simply put the file into the correct folder and CCLoader will pick it up automatically.

== Existing JSON files ==

Editing existing JSON files is problematic in a few cases. Now only are these files pretty big but there are also a lot of instances where multiple mods want to modify the same file. In that case simply replacing the entire file doesn’t work.

Instead you can use a mechanism called patches. These are files that only record the changes made to the original file, allowing multiple mods to apply patches to the same file. They work similar to file replacements as they require you to use the same name as the original file. The difference is that they append a <code>.patch</code> to the filename and use special sytanx exmplained in more detail on [[Patching]].

In order to work with JSON files it is recommend to beautify them before using them. You can use [https://beautifier.io/ beautifier.io] to do that for you.

In this example we will make a patch that will increase the damage Lea does. This information can be found in <code>assets/data/players/lea.json</code>. Once beautified one can easily see the value we want to modify.

<syntaxhighlight lang="json" line="line">
{
"character": "main.lea",
"sheet": "player",
"headIdx": 0,
"class": "SPHEROMANCER",
"stats": {
"hp": {
"base": 200,
"increase": 2000,
"variance": 0.1
},
"attack": {
"base": 20,
"increase": 200,
"variance": 0.9
},
...
</syntaxhighlight>

Now we want to somehow change <code>stats.attack.base</code> to <code>200</code>. For that we first create a patch file <code>assets/mods/myMod/assets/data/players/lea.json.patch</code>

🚀 '''Tip: Most editors will not recognize these files as JSON by default. Almost all popular editors include a feature to manually set which type of file you are currently editing.'''

First you can begin the file with <code>[]</code> to signal that this file is using the “Patch Step” format:

<syntaxhighlight lang="json" line="line">
[

]
</syntaxhighlight>

Next we insert a step that navigates into the <code>attack</code> object:

<syntaxhighlight lang="json" line="line">
{
"type": "ENTER",
"index": ["stats", "attack"]
}
</syntaxhighlight>

Now we can overwride a value:

<syntaxhighlight lang="json" line="line">
{
"type": "SET_KEY",
"index": "base",
"content": 200
}
</syntaxhighlight>

At the end, we navigate back to the root of the document. In this case it is not required but will make future additions a lot easier.

<syntaxhighlight lang="json" line="line">
{
"type": "EXIT",
"count": 2
}
</syntaxhighlight>

At the end we end up with this <code>lea.json.patch</code> file:

<syntaxhighlight lang="json" line="line">
[{
"type": "ENTER",
"index": ["stats", "attack"]
}, {
"type": "SET_KEY",
"index": "base",
"content": 200
}, {
"type": "EXIT",
"count": 2
}]
</syntaxhighlight>

= Making a JavaScript mod =

Although the game provides a very powerful JSON scripting system it is sometimes required to add new puzzle elements or edit internal workings of existing ones. For this one needs javascript mods.

== Requirements ==

* [[CrossCode Modding Tutorial#Making a mod|Making a mod]]

== Entry points ==

In order to load a JavaScript file, there needs to be an entry in the <code>package.json</code> of the mod. There are multiple possible values here that reference different points in time at which a mod is loaded. Furthermore there is an entry called <code>plugin</code> which combines all these entry points.

For example, if we want to double all gained CP points we need to add a script:

<syntaxhighlight lang="json" line="line">
{
"name": "my-mod",
"ccmodHumanName": "My Mod",
"version": "1.0.0",
"plugin": "plugin.js"
}
</syntaxhighlight>
{|
!width="100%"| ⚠ If you use entry points other than <code>plugin</code> you should always set <code>"module": true</code> as well.
|}

== Mod loading stages ==

=== Prestart ===

This is the entry point you usually want to use. At this point, most of the game code is loaded but almost none of it executed yet. This makes it the perfect chance to change how the internals work.

=== Preload ===

At this point none of the game has been loaded yet. This means that while nothing has loaded yet but one can use this to set up libraries or use some JavaScript black magic.

=== Postload ===

Here some of the game code has been loaded, however pretty much nothing has been executed yet. Specifically, none of the resources have been been loaded yet, making it possible to intercept and work with them.

=== Main ===

This stage, which has been called “main” for legacy reasons, executes code as soon as the title menu start playing. This allows mods to use code that may have not been executed yet in the prestart stage, though it should be avoided is easily possible.

== Plugin ==

While using loading stages directly in the <code>package.json</code> directly executes the code in a script the plugin combines multiple stages at once. Every plugin defines an exported JavaScript class that is used to execute the code.

Since we defined the file as <code>plugin.js</code> above we create a new file <code>assets/mods/myMod/plugin.js</code>:

<syntaxhighlight lang="js" line="line">
export default class MyMod {
prestart() {
//Prestart code will go in here.
}
}
</syntaxhighlight>
The advantage of using plugins over direct stages is that the constructor of the plugin receives an object as argument which can be used to find out which folder the current mod is stored in.

🚀 '''Tip: A plugin can also be used to write async code in a loading stage, blocking all other mods from loading until it has finished.'''

Now that we can execute code in the prestart stage, we need to find out how to double the CP points. If we look into the <code>assets/js/game.compiled.js</code> file we can find out that there is a class called <code>sc.PlayerModel</code> which contains a function

<source lang="ts">public addSkillPoints(points: number, element: number, all: boolean, extra: boolean): void</source>
We now want to manipulate <code>addSkillPoints</code> so that <code>points</code> are doubled. For that we can use the <code>inject</code> function. This is a function that exists on all classes that allows you to add and overwrite existing functions. Furthermore, inside that function you can use <code>this.parent(...)</code> to call the original functon.

We can use this to make a mod that doubles all CP:

<syntaxhighlight lang="js" line="line">
export default class MyMod {
prestart() {
sc.PlayerModel.inject({
addSkillPoints(points, element, all, extra) {
this.parent(points*2, element, all, extra);
}
});
}
}
</syntaxhighlight>

This example mod can be found on GitHub.<ref>https://github.com/CCDirectLink/CrossCode-Modding-Tutorial/tree/master/example</ref>

= Share your mod =

== Requirements ==

* [[CrossCode Modding Tutorial#Making a mod|Making a mod]]

== Steps ==

# Open your mod folder that contains the <code>package.json</code> file
# Select all files/folders needed for the mod
# Create a zip archive from these files. On Windows you can do this using right click > send to > zip-archived folder

You can already share this file

<ol start="4" style="list-style-type: decimal;">
<li>Rename the .zip file to .ccmod</li></ol>

This allows other users to simply drag the file into the mods folder and not have to worry about extracting it

== Publish on the official list ==

Since the process of approving a mod for the official list is a bit complicated (and is likely to change in the future) the best way is to:
* Publish your source code on [https://github.com/ GitHub]
* Make sure you have a correct version number
* Create a [https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository Github Release] - you can upload your .ccmod file there
* Message (an admin) on the [https://discord.gg/TFs6n5v CrossCode Modding Discord] to add your mod to the list

== References ==

<references />

[[Category:Modding guides]]

Main Page

2020-09-03T14:25:51Z

Dmitmel: Reverted edits by Dmitmel (talk) to last revision by Streetclaw

Welcome to the CCDirectLink wiki.

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

Main Page

2020-09-03T14:16:02Z

Dmitmel: Discord extension test

Welcome to the CCDirectLink wiki.

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

Please, join [https://discord.gg/TFs6n5v our Discord server] UwU.

Patching

2020-08-17T21:50:41Z

Dmitmel: Imported from https://github.com/CCDirectLink/documentation/blob/master/patching.md

<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]]

File:Faceless-mod-folder-contents-example.png

2020-08-17T21:33:27Z

Dmitmel:

File:Faceless-mod-path-example.png

2020-08-17T21:27:27Z

Dmitmel:

File:Lea-face-path.png

2020-08-17T21:26:22Z

Dmitmel:

File:Mod-assets-folder.png

2020-08-17T21:24:21Z

Dmitmel:

Dorito

2020-08-16T18:56:49Z

Dmitmel:

{| class="wikitable infobox-table" style="width: 20em;"
! Homepage
| [[github:Nnubes256/Dorito]]
|-
! Author
| [[user:Nnubes256|Ignacio "Nnubes256" Gutiérrez Gómez]]
|-
! Written in
| JavaScript
|-
! License
| MIT
|-
! First appeared
| Late 2015
|-
! Stable release
| N/A
|-
! Preview release
| N/A
|-
! Current status
| Discontinued
|}

'''Dorito''' was the first publicly available modloader for CrossCode, written by [[user:Nnubes256|Ignacio "Nnubes256" Gutiérrez Gómez]], released sometime in late 2015 and publicly announced on the [[CrossCode phpBB forums]].

Being the first CrossCode modloader project ever, it was very bare-bones compared to modern modloaders such as [[CCLoader]], as no modding infrastructure was in place at the time.

== Features ==

The major feature introduced by Dorito consisted of a collection of utilities for [[wikipedia:Monkey patch|monkey-patching]] JavaScript functions, along with a few game loading events implemented with [[github:millermedeiros/js-signals]], an event system written in JavaScript. These events resemble the mod loading stages found on modern modloaders. Another feature that made Dorito unique was its end-user installation procedure: the modloader was contained in a single HTML page which the user would replace CrossCode's <code>node-webkit.html</code> with. However, it had no support for static asset loading, nor other quality-of-life features now present on modern modloaders.

== Current status ==

Neither any Dorito-based mods, nor relevant [[CrossCode phpBB forums]] threads survived to this day. Parts of the so called "General Modding Thread" were able to be archived<ref>https://web.archive.org/web/20170811031608/http://forum.cross-code.com/viewtopic.php?f=2&t=250&sid=df33102d8a61a46731819a1416fce289</ref> (only pages 1 and from 8 to 11); however, no mentions of the Dorito modloader exists on the content that managed to get archived.

== References ==

<references />

[[Category:Modloaders]]

Template:Anchor

2020-08-16T15:52:53Z

Dmitmel:

Template:Anchor

2020-08-16T15:52:04Z

Dmitmel:

Template:Anchor

2020-08-16T15:51:45Z

Dmitmel:

Template:Anchor

2020-08-16T15:50:07Z

Dmitmel: Created page with "<includeonly></includeonly>"

Template:Lowercase title

2020-08-16T15:31:12Z

Dmitmel: Use an <includeonly> tag

<includeonly>{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}</includeonly><noinclude>Taken from https://www.mediawiki.org/wiki/Template:Lowercase</noinclude>

Template:Lowercase title

2020-08-16T15:30:31Z

Dmitmel: Created page with "{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}<noinclude>Taken from https://www.mediawiki.org/wiki/Template:L..."

{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}<noinclude>Taken from https://www.mediawiki.org/wiki/Template:Lowercase</noinclude>

Dorito

2020-08-16T15:25:16Z

Dmitmel: Use an interwiki ref

{| class="wikitable infobox-table" style="width: 20em;"
! Homepage
| [[github:Nnubes256/Dorito]]
|-
! Author
| [[user:Nnubes256|Ignacio "Nnubes256" Gutiérrez Gómez]]
|-
! Written in
| JavaScript
|-
! License
| MIT
|-
! First appeared
| Late 2015
|-
! Stable release
| N/A
|-
! Preview release
| N/A
|-
! Current status
| Discontinued
|}

'''Dorito''' was the first publicly available modloader for CrossCode, written by [[user:Nnubes256|Ignacio "Nnubes256" Gutiérrez Gómez]], released sometime in late 2015 and publicly announced on the [[CrossCode phpBB forums]].

Being the first CrossCode modloader project ever, it was very bare-bones compared to modern modloaders such as [[CCLoader]], as no modding infrastructure was in place at the time.

== Features ==

The major feature introduced by Dorito consisted of a collection of utilities for [[wikipedia:Monkey patch|monkey-patching]] JavaScript functions, along with a few game loading events implemented with [[github:millermedeiros/js-signals]], an event system written in JavaScript. These events resemble the mod loading stages found on modern modloaders. Another feature that made Dorito unique was its end-user installation procedure: the modloader was contained in a single HTML page which the user would replace CrossCode's <code>node-webkit.html</code> with. However, it had no support for static asset loading, nor other quality-of-life features now present on modern modloaders.

== Current status ==

Neither any Dorito-based mods, nor relevant [[CrossCode phpBB forums]] threads survived to this day. Parts of the so called "General Modding Thread" were able to be archived<ref>[https://web.archive.org/web/20170811031608/http://forum.cross-code.com/viewtopic.php?f=2&t=250&sid=df33102d8a61a46731819a1416fce289 Wayback Archive]</ref> (only pages 1 and from 8 to 11); however, no mentions of the Dorito modloader exists on the content that managed to get archived.

== References ==

<references />

[[Category:Modloaders]]

MediaWiki:Print.css

2020-08-14T19:53:40Z

Dmitmel:

/* CSS placed here will affect the print output */

img.block-img {
display: inline-block;
max-width: 100%;
height: auto;
}

table.infobox-table {
float: right;
clear: right;
margin-top: 0;
}

table.infobox-table th {
white-space: nowrap;
}

Dorito

2020-08-14T19:53:02Z

Dmitmel:

{| class="wikitable infobox-table" style="width: 20em;"
! Homepage
| [[github:Nnubes256/Dorito]]
|-
! Author
| [[github:Nnubes256]] aka Nacho
|-
! Written in
| JavaScript
|-
! License
| MIT
|-
! First appeared
| date unknown, most likely sometime after 2015-31-20
|-
! Stable release
| N/A
|-
! Preview release
| N/A
|-
! Current status
| Discontinued
|}

'''Dorito''' is the first publicly available modloader for CrossCode, released sometime during the [[forum]] days. As it's the first modloader project ever, it was very bare-bones compared to the [[CCLoader|modern modloaders]] as the useful modding infrastructure simply hasn't been invented yet at the time. The major feature of Dorito was a collection of utilities for monkey-patching JS functions, along with a few game loading events implemented with [[github:millermedeiros/js-signals]] which resemble the modern [[mod loading stages]]. Another feature that made Dorito unique was its installation procedure: the loader was contained in a single HTML page which you had to replace <code>node-webkit.html</code> with.

Unfortunately neither any Dorito-based mods, nor relevant [[forum]] threads survived to this day. Parts of the "General Modding Thread" can be viewed on [http://web.archive.org/web/20170811031608/http://forum.cross-code.com/viewtopic.php?f=2&t=250&sid=df33102d8a61a46731819a1416fce289 web.archive.org] (only pages 1 and from 8 to 11), however, there are no mentions of Dorito-the-modloader there.

[[Category:Modloaders]]

CCInjector

2020-08-14T19:51:54Z

Dmitmel:

{| class="wikitable infobox-table" style="width: 21em;"
! Homepage
| [[github:CCDirectLink/CCInjector]]
|-
! Author
| [[github:ac2pic]] aka Emileyah
|-
! Written in
| JavaScript
|-
! License
| MIT
|-
! First appeared
| 2019-05-19
|-
! Stable release
| N/A
|-
! Preview release
| N/A
|-
! Current status
| Discontinued
|}

WIP

[[Category:Modloaders]]

MediaWiki:Common.css

2020-08-14T19:51:04Z

Dmitmel: Disable word wrapping in table header elements of infoboxes

/* CSS placed here will be applied to all skins */

img.block-img {
display: inline-block;
max-width: 100%;
height: auto;
}

table.infobox-table {
float: right;
clear: right;
margin-top: 0;
margin: 0.5em 0 0.5em 1em;
}

table.infobox-table th {
white-space: nowrap;
}

Dorito

2020-08-14T07:29:59Z

Dmitmel: Mention the installation process

{| class="wikitable infobox-table" style="width: 20em;"
! style="white-space: nowrap;" | Homepage
| [[github:Nnubes256/Dorito]]
|-
! style="white-space: nowrap;" | Author
| [[github:Nnubes256]] aka Nacho
|-
! style="white-space: nowrap;" | Written in
| JavaScript
|-
! style="white-space: nowrap;" | License
| MIT
|-
! style="white-space: nowrap;" | First appeared
| date unknown, most likely sometime after 2015-31-20
|-
! style="white-space: nowrap;" | Stable release
| N/A
|-
! style="white-space: nowrap;" | Preview release
| N/A
|-
! style="white-space: nowrap;" | Current status
| Discontinued
|}

'''Dorito''' is the first publicly available modloader for CrossCode, released sometime during the [[forum]] days. As it's the first modloader project ever, it was very bare-bones compared to the [[CCLoader|modern modloaders]] as the useful modding infrastructure simply hasn't been invented yet at the time. The major feature of Dorito was a collection of utilities for monkey-patching JS functions, along with a few game loading events implemented with [[github:millermedeiros/js-signals]] which resemble the modern [[mod loading stages]]. Another feature that made Dorito unique was its installation procedure: the loader was contained in a single HTML page which you had to replace <code>node-webkit.html</code> with.

Unfortunately neither any Dorito-based mods, nor relevant [[forum]] threads survived to this day. Parts of the "General Modding Thread" can be viewed on [http://web.archive.org/web/20170811031608/http://forum.cross-code.com/viewtopic.php?f=2&t=250&sid=df33102d8a61a46731819a1416fce289 web.archive.org] (only pages 1 and from 8 to 11), however, there are no mentions of Dorito-the-modloader there.

[[Category:Modloaders]]

CCInjector

2020-08-13T22:55:40Z

Dmitmel: Add an infobox

{| class="wikitable infobox-table" style="width: 21em;"
! style="white-space: nowrap;" | Homepage
| [[github:CCDirectLink/CCInjector]]
|-
! style="white-space: nowrap;" | Author
| [[github:ac2pic]] aka Emileyah
|-
! style="white-space: nowrap;" | Written in
| JavaScript
|-
! style="white-space: nowrap;" | License
| MIT
|-
! style="white-space: nowrap;" | First appeared
| 2019-05-19
|-
! style="white-space: nowrap;" | Stable release
| N/A
|-
! style="white-space: nowrap;" | Preview release
| N/A
|-
! style="white-space: nowrap;" | Current status
| Discontinued
|}

[[Category:Modloaders]]

Dorito

2020-08-13T17:28:32Z

Dmitmel: Add some actual content, awaiting a review from Nacho

{| class="wikitable infobox-table" style="width: 20em;"
! style="white-space: nowrap;" | Homepage
| [[github:Nnubes256/Dorito]]
|-
! style="white-space: nowrap;" | Author
| [[github:Nnubes256]] aka Nacho
|-
! style="white-space: nowrap;" | Written in
| JavaScript
|-
! style="white-space: nowrap;" | License
| MIT
|-
! style="white-space: nowrap;" | First appeared
| date unknown, most likely sometime after 2015-31-20
|-
! style="white-space: nowrap;" | Stable release
| N/A
|-
! style="white-space: nowrap;" | Preview release
| N/A
|-
! style="white-space: nowrap;" | Current status
| Discontinued
|}

'''Dorito''' is the first publicly available modloader for CrossCode, released sometime during the [[forum]] days. As it's the first modloader project ever, it was very bare-bones compared to the [[CCLoader|modern modloaders]] as the useful modding infrastructure simply hasn't been invented yet at the time. The major feature of Dorito was a collection of utilities for monkey-patching JS functions, along with a few game loading events implemented with [[github:millermedeiros/js-signals]] which resemble the modern [[mod loading stages]].

Unfortunately neither any Dorito-based mods, nor relevant [[forum]] threads survived to this day. Parts of the "General Modding Thread" can be viewed on [http://web.archive.org/web/20170811031608/http://forum.cross-code.com/viewtopic.php?f=2&t=250&sid=df33102d8a61a46731819a1416fce289 web.archive.org] (only pages 1 and from 8 to 11), however, there are no mentions of Dorito-the-modloader there.

[[Category:Modloaders]]

MediaWiki:Common.css

2020-08-13T17:13:10Z

Dmitmel: Add some margins to the infobox table

Locations of CrossCode files

2020-08-13T14:54:26Z

Dmitmel: Fix platform-specific images after the skin update

== Save folder ==

There isn't really much to say about this folder other than:

# It isn't located in the [[#Game files folder|'''game files folder''']], so you can delete and reinstall the game without losing your progress or settings.
# It is located in the nw.js's browser cache folder.

Here're the direct paths to the save file on various platforms:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>%LOCALAPPDATA%\CrossCode\cc.save</code>
|-
| '''GNU/Linux'''
| <code>~/.config/CrossCode/Default/cc.save</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/CrossCode/Default/cc.save</code>
|}

Similarly named files <code>cc.save.backup</code> and <code>cc.save.backup2</code> exist and can be used to restore the save file in case it becomes corrupt.

For now this section is incomplete and more information can be obtained on the [https://crosscode.gamepedia.com/Savegame game's wiki].

== Game installation folder ==

You would probably know where you installed the game better than me. However, here's a quick way to locate the installation folder in case you are using Steam:

# Find CrossCode in your game library</li>
# Right-click it, in the context menu press <code>Properties...</code> [[File:Steam-crosscode-properties.png|class=block-img]]
# In the new window select the <code>LOCAL FILES</code> tab
# You'll be presented with the following menu: [[File:steam-browse-local-files.png|class=block-img]]
# Click the <code>BROWSE LOCAL FILES...</code> button and you'll be taken to the installation folder.

The common paths where Steam installs CrossCode are:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>C:\Program Files\Steam\steamapps\common\CrossCode</code>
|-
| '''GNU/Linux'''
| <code>~/.local/share/Steam/steamapps/common/CrossCode</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/Steam/steamapps/common/CrossCode</code>
|}

Here's how this folder looks on different platforms:

'''MS Windows:'''
[[File:Clean-game-files-directory.windows.png|class=block-img]]

'''GNU/Linux:'''
[[File:Clean-game-files-directory.linux.png|class=block-img]]

'''macOS:'''
[[File:Clean-game-installation-directory.macos.png|class=block-img]]

== Game files folder ==

Due to the, uhm... ''interesting'' structure of the CrossCode's macOS application, the [[#Game installation folder|'''game installation folder''']] is not necessarily the same as the '''game files folder'''. It also isn't the same as the [[#Game assets folder|'''game assets folder''']]. Files (HTML pages and JavaScript scripts) in this folder have full access to all of the game's nw.js's features, and thus this folder is commonly used as a home for mods, modding tools and CCLoader in particular. On MS Windows and GNU/Linux it is the same as the installation folder, as such it also contains nw.js's files on these platforms.

Anyway, here are the contents of this folder on different platforms in a fresh non-modded copy of CrossCode:

'''MS Windows:'''
[[File:Clean-game-files-directory.windows.png|class=block-img]]

'''GNU/Linux:'''
[[File:Clean-game-files-directory.linux.png|class=block-img]]

'''macOS:'''
[[File:Clean-game-files-directory.macos.png|class=block-img]]

There are a few files which are common between all platforms:

* <code>assets</code> - obviously, the [[#Game assets folder|'''game assets folder''']]
* <code>favicon.png</code> - the application icon (interestingly enough the <code>.exe</code> file for Windows has a different icon)
* <code>package.json</code> - contains the path to an HTML page which is opened immediately when you start the game and initial configuration for the window this page is opened in (like dimensions, fullscreen mode, resizable or not etc)
* <code>steam_appid.txt</code> - to my knowledge it is created automatically by Steam and in the case of CrossCode just contains the text <code>368340</code>

All other files come from the standard nw.js packages [https://dl.nwjs.io/v0.35.5/ you can download yourself] and '''weren't created by RadicalFishGames'''. All aforementioned files though are identical on all platforms, which means that you can take them from an installation on another platform, download the nw.js package on a different OS, place the game files inside and you'll get a (synthetic, hehe) runnable version of the game on this another OS. (TODO: maybe I should write a guide for that as well)

=== How to locate the game files folder ===

'''MS Windows''' and '''GNU/Linux''': Simply find your [[#Game installation folder|'''game installation folder''']], it's the same as the game files folder on these platforms.

'''macOS:''' Extra care needs to be taken on mac because the game files are stored inside of nw.js's application. After locating the [[#Game installation folder|'''game installation folder''']] you need to:

# Right-click the app named <code>nwjs</code> or <code>CrossCode</code>
# In the context menu select <code>Show Package Contents</code> [[File:Macos-show-nwjs-package-contents.png|class=block-img]]
# Go to the folder named <code>Contents</code>, then <code>Resources</code>, then <code>app.nw</code> [[File:Macos-package-contents-app-nw.png|class=block-img]]
# Here you go, this is the game files folder!

== Game assets folder ==

TODO

[[Category:Guides for mod users]]

MediaWiki:Print.css

2020-08-13T13:47:53Z

Dmitmel: Copy contents of Common.css

/* CSS placed here will affect the print output */

img.block-img {
display: inline-block;
max-width: 100%;
height: auto;
}

table.infobox-table {
float: right;
clear: right;
margin-top: 0;
}

MediaWiki:Common.css

2020-08-13T13:17:22Z

Dmitmel: Re-indent with 4 spaces, which is a more commonly used code style in CCDirectLink

/* CSS placed here will be applied to all skins */

img.block-img {
display: inline-block;
max-width: 100%;
height: auto;
}

table.infobox-table {
float: right;
clear: right;
margin-top: 0;
}

MediaWiki:Common.css

2020-08-13T13:15:18Z

Dmitmel: Add an "infobox-table" class

/* CSS placed here will be applied to all skins */

img.block-img {
display: inline-block;
max-width: 100%;
height: auto;
}

table.infobox-table {
float: right;
clear: right;
margin-top: 0;
}

CCLoader

2020-08-12T10:07:32Z

Dmitmel: Undo revision 84 by Dmitmel (talk)

'''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/dmitmel/ccloader3/releases/latest latest release page] of CCLoader. (TODO update the URL when v3 is released)
# Download the archive named '''<code>ccloader_X.Y.Z_quick-install.zip</code>''' (<code>tar.gz</code> archives also exist for GNU/Linux and macOS users). '''It is important that you download the archive named <code>quick-install</code> and not the source code or something else.'''
# Extract this archive somewhere: [[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this: [[File:Ccloader-quick-install.png|class=block-img]] The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>: [[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): [[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:

<source lang="bash">cd /path/to/CrossCode
# TODO update the URL here as well
curl --location --fail 'https://github.com/dmitmel/ccloader3/releases/download/v3.0.0-alpha/ccloader_3.0.0-alpha_quick-install.tar.gz' \
| tar --extract --gzip --verbose --file -</source>

=== 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.

== Method 3: Manual installation of the CCLoader-only package ==

This method is not really intended for regular users, rather this section is a description of the full installation process intended as a reference when implementing tools for automatic CCLoader installation. It is also subject to change in the future, although that's not likely.

# Locate the [[Locations of CrossCode files#Game files folder|CrossCode game files directory]].
# Create a directory for CCLoader files, named, for example, <code>ccloader</code>.
# Download and unpack the release archive named <code>ccloader_X.Y.Z_package.zip</code> or <code>ccloader_X.Y.Z_package.tar.gz</code> into this directory.
# Change the <code>main</code> field in game's <code>package.json</code> from <code>assets/node-webkit.html</code> to <code>ccloader/main.html</code>.
# Create a directory named <code>mods</code> inside game's <code>assets</code>.
# The installation is complete.

[[Category:Modloaders]]

CCLoader

2020-08-12T10:05:25Z

Dmitmel: Test edit for my mediawiki-preview script, I will undo in a moment

'''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/dmitmel/ccloader3/releases/latest latest release page] of CCLoader. (TODO update the URL when v3 is released)
# Download the archive named '''<code>ccloader_X.Y.Z_quick-install.zip</code>''' (<code>tar.gz</code> archives also exist for GNU/Linux and macOS users). '''It is important that you download the archive named <code>quick-install</code> and not the source code or something else.'''
# Extract this archive somewhere: [[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this: [[File:Ccloader-quick-install.png|class=block-img]] The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>: [[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): [[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:

<source lang="bash">cd /path/to/CrossCode
# TODO update the URL here as well
curl --location --fail 'https://github.com/dmitmel/ccloader3/releases/download/v3.0.0-alpha/ccloader_3.0.0-alpha_quick-install.tar.gz' \
| tar --extract --gzip --verbose --file -</source>

=== 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.

== Method 3: Manual installation of the CCLoader-only package ==

This method is not really intended for regular users, rather this section is a description of the full installation process intended as a reference when implementing tools for automatic CCLoader installation. It is also subject to change in the future, although that's not likely.

# Locate the [[Locations of CrossCode files#Game files folder|CrossCode game files directory]].
# Create a directory for CCLoader files, named, for example, <code>ccloader</code>.
# Download and unpack the release archive named <code>ccloader_X.Y.Z_package.zip</code> or <code>ccloader_X.Y.Z_package.tar.gz</code> into this directory.
# Change the <code>main</code> field in game's <code>package.json</code> from <code>assets/node-webkit.html</code> to <code>ccloader/main.html</code>.
# Create a directory named <code>mods</code> inside game's <code>assets</code>.
# The installation is complete.

[[Category:Modloaders]]
<indicator name="test123">abc</indicator>
<indicator name="test456">def</indicator>

Locations of CrossCode files

2020-08-11T12:01:24Z

Dmitmel:

== Save folder ==

There isn't really much to say about this folder other than:

# It isn't located in the [[#Game files folder|'''game files folder''']], so you can delete and reinstall the game without losing your progress or settings.
# It is located in the nw.js's browser cache folder.

Here're the direct paths to the save file on various platforms:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>%LOCALAPPDATA%\CrossCode\cc.save</code>
|-
| '''GNU/Linux'''
| <code>~/.config/CrossCode/Default/cc.save</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/CrossCode/Default/cc.save</code>
|}

Similarly named files <code>cc.save.backup</code> and <code>cc.save.backup2</code> exist and can be used to restore the save file in case it becomes corrupt.

For now this section is incomplete and more information can be obtained on the [https://crosscode.gamepedia.com/Savegame game's wiki].

== Game installation folder ==

You would probably know where you installed the game better than me. However, here's a quick way to locate the installation folder in case you are using Steam:

# Find CrossCode in your game library</li>
# Right-click it, in the context menu press <code>Properties...</code> [[File:Steam-crosscode-properties.png|class=block-img]]
# In the new window select the <code>LOCAL FILES</code> tab
# You'll be presented with the following menu: [[File:steam-browse-local-files.png|class=block-img]]
# Click the <code>BROWSE LOCAL FILES...</code> button and you'll be taken to the installation folder.

The common paths where Steam installs CrossCode are:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>C:\Program Files\Steam\steamapps\common\CrossCode</code>
|-
| '''GNU/Linux'''
| <code>~/.local/share/Steam/steamapps/common/CrossCode</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/Steam/steamapps/common/CrossCode</code>
|}

Here's how this folder looks on different platforms:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-installation-directory.macos.png|frame|none|'''macOS''']]

== Game files folder ==

Due to the, uhm... ''interesting'' structure of the CrossCode's macOS application, the [[#Game installation folder|'''game installation folder''']] is not necessarily the same as the '''game files folder'''. It also isn't the same as the [[#Game assets folder|'''game assets folder''']]. Files (HTML pages and JavaScript scripts) in this folder have full access to all of the game's nw.js's features, and thus this folder is commonly used as a home for mods, modding tools and CCLoader in particular. On MS Windows and GNU/Linux it is the same as the installation folder, as such it also contains nw.js's files on these platforms.

Anyway, here are the contents of this folder on different platforms in a fresh non-modded copy of CrossCode:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-files-directory.macos.png|frame|none|'''macOS''']]

There are a few files which are common between all platforms:

* <code>assets</code> - obviously, the [[#Game assets folder|'''game assets folder''']]
* <code>favicon.png</code> - the application icon (interestingly enough the <code>.exe</code> file for Windows has a different icon)
* <code>package.json</code> - contains the path to an HTML page which is opened immediately when you start the game and initial configuration for the window this page is opened in (like dimensions, fullscreen mode, resizable or not etc)
* <code>steam_appid.txt</code> - to my knowledge it is created automatically by Steam and in the case of CrossCode just contains the text <code>368340</code>

All other files come from the standard nw.js packages [https://dl.nwjs.io/v0.35.5/ you can download yourself] and '''weren't created by RadicalFishGames'''. All aforementioned files though are identical on all platforms, which means that you can take them from an installation on another platform, download the nw.js package on a different OS, place the game files inside and you'll get a (synthetic, hehe) runnable version of the game on this another OS. (TODO: maybe I should write a guide for that as well)

=== How to locate the game files folder ===

'''MS Windows''' and '''GNU/Linux''': Simply find your [[#Game installation folder|'''game installation folder''']], it's the same as the game files folder on these platforms.

'''macOS:''' Extra care needs to be taken on mac because the game files are stored inside of nw.js's application. After locating the [[#Game installation folder|'''game installation folder''']] you need to:

# Right-click the app named <code>nwjs</code> or <code>CrossCode</code>
# In the context menu select <code>Show Package Contents</code> [[File:Macos-show-nwjs-package-contents.png|class=block-img]]
# Go to the folder named <code>Contents</code>, then <code>Resources</code>, then <code>app.nw</code> [[File:Macos-package-contents-app-nw.png|class=block-img]]
# Here you go, this is the game files folder!

== Game assets folder ==

TODO

[[Category:Guides for mod users]]

CCLoader

2020-08-11T11:14:16Z

Dmitmel: Link to the wiki pages of modloaders

'''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/dmitmel/ccloader3/releases/latest latest release page] of CCLoader. (TODO update the URL when v3 is released)
# Download the archive named '''<code>ccloader_X.Y.Z_quick-install.zip</code>''' (<code>tar.gz</code> archives also exist for GNU/Linux and macOS users). '''It is important that you download the archive named <code>quick-install</code> and not the source code or something else.'''
# Extract this archive somewhere: [[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this: [[File:Ccloader-quick-install.png|class=block-img]] The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>: [[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): [[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:

<source lang="bash">cd /path/to/CrossCode
# TODO update the URL here as well
curl --location --fail 'https://github.com/dmitmel/ccloader3/releases/download/v3.0.0-alpha/ccloader_3.0.0-alpha_quick-install.tar.gz' \
| tar --extract --gzip --verbose --file -</source>

=== 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.

== Method 3: Manual installation of the CCLoader-only package ==

This method is not really intended for regular users, rather this section is a description of the full installation process intended as a reference when implementing tools for automatic CCLoader installation. It is also subject to change in the future, although that's not likely.

# Locate the [[Locations of CrossCode files#Game files folder|CrossCode game files directory]].
# Create a directory for CCLoader files, named, for example, <code>ccloader</code>.
# Download and unpack the release archive named <code>ccloader_X.Y.Z_package.zip</code> or <code>ccloader_X.Y.Z_package.tar.gz</code> into this directory.
# Change the <code>main</code> field in game's <code>package.json</code> from <code>assets/node-webkit.html</code> to <code>ccloader/main.html</code>.
# Create a directory named <code>mods</code> inside game's <code>assets</code>.
# The installation is complete.

[[Category:Modloaders]]

CCInjector

2020-08-11T11:13:43Z

Dmitmel: Add a link to the homepage

WIP

Homepage: https://github.com/CCDirectLink/CCInjector

[[Category:Modloaders]]

Dorito

2020-08-11T08:53:43Z

Dmitmel: Add a link to the homepage

WIP

Homepage: https://github.com/Nnubes256/Dorito

[[Category:Modloaders]]

CCInjector

2020-08-11T08:52:06Z

Dmitmel: Created page with "WIP Category:Modloaders"

WIP

[[Category:Modloaders]]

Dorito

2020-08-11T08:51:42Z

Dmitmel: Created page with "WIP Category:Modloaders"

WIP

[[Category:Modloaders]]

Category:Guides for mod users

2020-08-11T08:49:54Z

Dmitmel: Created blank page

Locations of CrossCode files

2020-08-11T08:48:08Z

Dmitmel: Remove underscores from anchor links

== Save folder ==

There isn't really much to say about this folder other than:

# It isn't located in the [[#Game files folder|'''game files folder''']], so you can delete and reinstall the game without losing your progress or settings.
# It is located in the nw.js's browser cache folder.

Here're the direct paths to the save file on various platforms:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>%LOCALAPPDATA%\CrossCode\cc.save</code>
|-
| '''GNU/Linux'''
| <code>~/.config/CrossCode/Default/cc.save</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/CrossCode/Default/cc.save</code>
|}

Similarly named files <code>cc.save.backup</code> and <code>cc.save.backup2</code> exist and can be used to restore the save file in case it becomes corrupt.

For now this section is incomplete and more information can be obtained on the [https://crosscode.gamepedia.com/Savegame game's wiki].

== Game installation folder ==

You would probably know where you installed the game better than myself. However, here's a quick way to locate the installation folder in case you are using Steam:

# Find CrossCode in your game library</li>
# Right-click it, in the context menu press <code>Properties...</code> [[File:Steam-crosscode-properties.png|class=block-img]]
# In the new window select the <code>LOCAL FILES</code> tab
# You'll be presented with the following menu: [[File:steam-browse-local-files.png|class=block-img]]
# Click the <code>BROWSE LOCAL FILES...</code> button and you'll be taken to the installation folder.

The common paths where Steam installs CrossCode are:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>C:\Program Files\Steam\steamapps\common\CrossCode</code>
|-
| '''GNU/Linux'''
| <code>~/.local/share/Steam/steamapps/common/CrossCode</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/Steam/steamapps/common/CrossCode</code>
|}

Here's how this folder looks on different platforms:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-installation-directory.macos.png|frame|none|'''macOS''']]

== Game files folder ==

Due to the, uhm... ''interesting'' structure of the CrossCode's macOS application, the [[#Game installation folder|'''game installation folder''']] is not necessarily the same as the '''game files folder'''. It also isn't the same as the [[#Game assets folder|'''game assets folder''']]. Files (HTML pages and JavaScript scripts) in this folder have full access to all of the game's nw.js's features, and thus this folder is commonly used as a home for mods, modding tools and CCLoader in particular. On MS Windows and GNU/Linux it is the same as the installation folder, as such it also contains nw.js's files on these platforms.

Anyway, here are the contents of this folder on different platforms in a fresh non-modded copy of CrossCode:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-files-directory.macos.png|frame|none|'''macOS''']]

There are a few files which are common between all platforms:

* <code>assets</code> - obviously, the [[#Game assets folder|'''game assets folder''']]
* <code>favicon.png</code> - the application icon (interestingly enough the <code>.exe</code> file for Windows has a different icon)
* <code>package.json</code> - contains the path to an HTML page which is opened immediately when you start the game and initial configuration for the window this page is opened in (like dimensions, fullscreen mode, resizable or not etc)
* <code>steam_appid.txt</code> - to my knowledge it is created automatically by Steam and in the case of CrossCode just contains the text <code>368340</code>

All other files come from the standard nw.js packages [https://dl.nwjs.io/v0.35.5/ you can download yourself] and '''weren't created by RadicalFishGames'''. All aforementioned files though are identical on all platforms, which means that you can take them from an installation on another platform, download the nw.js package on a different OS, place the game files inside and you'll get a (synthetic, hehe) runnable version of the game on this another OS. (TODO: maybe I should write a guide for that as well)

=== How to locate the game files folder ===

'''MS Windows''' and '''GNU/Linux''': Simply find your [[#Game installation folder|'''game installation folder''']], it's the same as the game files folder on these platforms.

'''macOS:''' Extra care needs to be taken on mac because the game files are stored inside of nw.js's application. After locating the [[#Game installation folder|'''game installation folder''']] you need to:

# Right-click the app named <code>nwjs</code> or <code>CrossCode</code>
# In the context menu select <code>Show Package Contents</code> [[File:Macos-show-nwjs-package-contents.png|class=block-img]]
# Go to the folder named <code>Contents</code>, then <code>Resources</code>, then <code>app.nw</code> [[File:Macos-package-contents-app-nw.png|class=block-img]]
# Here you go, this is the game files folder!

== Game assets folder ==

TODO

[[Category:Guides for mod users]]

Locations of CrossCode files

2020-08-11T08:46:15Z

Dmitmel: Undo revision 49 by Dmitmel (talk)

== Save folder ==

There isn't really much to say about this folder other than:

# It isn't located in the [[#Game_files_folder|'''game files folder''']], so you can delete and reinstall the game without losing your progress or settings.
# It is located in the nw.js's browser cache folder.

Here're the direct paths to the save file on various platforms:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>%LOCALAPPDATA%\CrossCode\cc.save</code>
|-
| '''GNU/Linux'''
| <code>~/.config/CrossCode/Default/cc.save</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/CrossCode/Default/cc.save</code>
|}

Similarly named files <code>cc.save.backup</code> and <code>cc.save.backup2</code> exist and can be used to restore the save file in case it becomes corrupt.

For now this section is incomplete and more information can be obtained on the [https://crosscode.gamepedia.com/Savegame game's wiki].

== Game installation folder ==

You would probably know where you installed the game better than myself. However, here's a quick way to locate the installation folder in case you are using Steam:

# Find CrossCode in your game library</li>
# Right-click it, in the context menu press <code>Properties...</code> [[File:Steam-crosscode-properties.png|class=block-img]]
# In the new window select the <code>LOCAL FILES</code> tab
# You'll be presented with the following menu: [[File:steam-browse-local-files.png|class=block-img]]
# Click the <code>BROWSE LOCAL FILES...</code> button and you'll be taken to the installation folder.

The common paths where Steam installs CrossCode are:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>C:\Program Files\Steam\steamapps\common\CrossCode</code>
|-
| '''GNU/Linux'''
| <code>~/.local/share/Steam/steamapps/common/CrossCode</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/Steam/steamapps/common/CrossCode</code>
|}

Here's how this folder looks on different platforms:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-installation-directory.macos.png|frame|none|'''macOS''']]

== Game files folder ==

Due to the, uhm... ''interesting'' structure of the CrossCode's macOS application, the [[#Game_installation_folder|'''game installation folder''']] is not necessarily the same as the '''game files folder'''. It also isn't the same as the [[#Game_assets_folder|'''game assets folder''']]. Files (HTML pages and JavaScript scripts) in this folder have full access to all of the game's nw.js's features, and thus this folder is commonly used as a home for mods, modding tools and CCLoader in particular. On MS Windows and GNU/Linux it is the same as the installation folder, as such it also contains nw.js's files on these platforms.

Anyway, here are the contents of this folder on different platforms in a fresh non-modded copy of CrossCode:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-files-directory.macos.png|frame|none|'''macOS''']]

There are a few files which are common between all platforms:

* <code>assets</code> - obviously, the [[#Game_assets_folder|'''game assets folder''']]
* <code>favicon.png</code> - the application icon (interestingly enough the <code>.exe</code> file for Windows has a different icon)
* <code>package.json</code> - contains the path to an HTML page which is opened immediately when you start the game and initial configuration for the window this page is opened in (like dimensions, fullscreen mode, resizable or not etc)
* <code>steam_appid.txt</code> - to my knowledge it is created automatically by Steam and in the case of CrossCode just contains the text <code>368340</code>

All other files come from the standard nw.js packages [https://dl.nwjs.io/v0.35.5/ you can download yourself] and '''weren't created by RadicalFishGames'''. All aforementioned files though are identical on all platforms, which means that you can take them from an installation on another platform, download the nw.js package on a different OS, place the game files inside and you'll get a (synthetic, hehe) runnable version of the game on this another OS. (TODO: maybe I should write a guide for that as well)

=== How to locate the game files folder ===

'''MS Windows''' and '''GNU/Linux''': Simply find your [[#Game_installation_folder|'''game installation folder''']], it's the same as the game files folder on these platforms.

'''macOS:''' Extra care needs to be taken on mac because the game files are stored inside of nw.js's application. After locating the [[#Game_installation_folder|'''game installation folder''']] you need to:

# Right-click the app named <code>nwjs</code> or <code>CrossCode</code>
# In the context menu select <code>Show Package Contents</code> [[File:Macos-show-nwjs-package-contents.png|class=block-img]]
# Go to the folder named <code>Contents</code>, then <code>Resources</code>, then <code>app.nw</code> [[File:Macos-package-contents-app-nw.png|class=block-img]]
# Here you go, this is the game files folder!

== Game assets folder ==

TODO

[[Category:Guides for mod users]]

Locations of CrossCode files

2020-08-11T08:44:30Z

Dmitmel: Substitute "folder" with "directory"

== Save directory ==

There isn't really much to say about this directory other than:

# It isn't located in the [[#Game_files_directory|'''game files directory''']], so you can delete and reinstall the game without losing your progress or settings.
# It is located in the nw.js's browser cache directory.

Here're the direct paths to the save file on various platforms:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>%LOCALAPPDATA%\CrossCode\cc.save</code>
|-
| '''GNU/Linux'''
| <code>~/.config/CrossCode/Default/cc.save</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/CrossCode/Default/cc.save</code>
|}

Similarly named files <code>cc.save.backup</code> and <code>cc.save.backup2</code> exist and can be used to restore the save file in case it becomes corrupt.

For now this section is incomplete and more information can be obtained on the [https://crosscode.gamepedia.com/Savegame game's wiki].

== Game installation directory ==

You would probably know where you installed the game better than myself. However, here's a quick way to locate the installation directory in case you are using Steam:

# Find CrossCode in your game library</li>
# Right-click it, in the context menu press <code>Properties...</code> [[File:Steam-crosscode-properties.png|class=block-img]]
# In the new window select the <code>LOCAL FILES</code> tab
# You'll be presented with the following menu: [[File:steam-browse-local-files.png|class=block-img]]
# Click the <code>BROWSE LOCAL FILES...</code> button and you'll be taken to the installation directory.

The common paths where Steam installs CrossCode are:

{| class="wikitable"
! Platform
! Installation path
|-
| '''MS Windows'''
| <code>C:\Program Files\Steam\steamapps\common\CrossCode</code>
|-
| '''GNU/Linux'''
| <code>~/.local/share/Steam/steamapps/common/CrossCode</code>
|-
| '''macOS'''
| <code>~/Library/Application Support/Steam/steamapps/common/CrossCode</code>
|}

Here's how this directory looks on different platforms:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-installation-directory.macos.png|frame|none|'''macOS''']]

== Game files directory ==

Due to the, uhm... ''interesting'' structure of the CrossCode's macOS application, the [[#Game_installation_directory|'''game installation directory''']] is not necessarily the same as the '''game files directory'''. It also isn't the same as the [[#Game_assets_directory|'''game assets directory''']]. Files (HTML pages and JavaScript scripts) in this directory have full access to all of the game's nw.js's features, and thus this directory is commonly used as a home for mods, modding tools and CCLoader in particular. On MS Windows and GNU/Linux it is the same as the installation directory, as such it also contains nw.js's files on these platforms.

Anyway, here are the contents of this directory on different platforms in a fresh non-modded copy of CrossCode:

[[File:Clean-game-files-directory.windows.png|frame|none|'''MS Windows''']]

[[File:Clean-game-files-directory.linux.png|frame|none|'''GNU/Linux''']]

[[File:Clean-game-files-directory.macos.png|frame|none|'''macOS''']]

There are a few files which are common between all platforms:

* <code>assets</code> - obviously, the [[#Game_assets_directory|'''game assets directory''']]
* <code>favicon.png</code> - the application icon (interestingly enough the <code>.exe</code> file for Windows has a different icon)
* <code>package.json</code> - contains the path to an HTML page which is opened immediately when you start the game and initial configuration for the window this page is opened in (like dimensions, fullscreen mode, resizable or not etc)
* <code>steam_appid.txt</code> - to my knowledge it is created automatically by Steam and in the case of CrossCode just contains the text <code>368340</code>

All other files come from the standard nw.js packages [https://dl.nwjs.io/v0.35.5/ you can download yourself] and '''weren't created by RadicalFishGames'''. All aforementioned files though are identical on all platforms, which means that you can take them from an installation on another platform, download the nw.js package on a different OS, place the game files inside and you'll get a (synthetic, hehe) runnable version of the game on this another OS. (TODO: maybe I should write a guide for that as well)

=== How to locate the game files directory ===

'''MS Windows''' and '''GNU/Linux''': Simply find your [[#Game_installation_directory|'''game installation directory''']], it's the same as the game files directory on these platforms.

'''macOS:''' Extra care needs to be taken on mac because the game files are stored inside of nw.js's application. After locating the [[#Game_installation_directory|'''game installation directory''']] you need to:

# Right-click the app named <code>nwjs</code> or <code>CrossCode</code>
# In the context menu select <code>Show Package Contents</code> [[File:Macos-show-nwjs-package-contents.png|class=block-img]]
# Go to the directory named <code>Contents</code>, then <code>Resources</code>, then <code>app.nw</code> [[File:Macos-package-contents-app-nw.png|class=block-img]]
# Here you go, this is the game files directory!

== Game assets directory ==

TODO

[[Category:Guides for mod users]]

Locations of CrossCode files

2020-08-11T08:42:31Z

Dmitmel:

Installing mods

2020-08-11T08:42:06Z

Dmitmel:

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: [[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 ==

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. Then 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]]

Installing mods

2020-08-11T08:40:11Z

Dmitmel:

Installing mods

2020-08-11T08:40:03Z

Dmitmel:

= Installing and updating mods =

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: [[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 ==

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. Then 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>.
|}

Locations of CrossCode files

2020-08-11T08:36:51Z

Dmitmel:

Category:Modloaders

2020-08-11T08:34:40Z

Dmitmel: Created page with "'''Modloaders''' are programs which start the game and load mods into it, provide interface for users to configure the loaded mods, and tools and utilities for mod developers."

'''Modloaders''' are programs which start the game and load mods into it, provide interface for users to configure the loaded mods, and tools and utilities for mod developers.

CCLoader

2020-08-11T08:29:15Z

Dmitmel:

'''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], [https://github.com/Nnubes256/Dorito Dorito] and [https://github.com/CCDirectLink/CCInjector 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/dmitmel/ccloader3/releases/latest latest release page] of CCLoader. (TODO update the URL when v3 is released)
# Download the archive named '''<code>ccloader_X.Y.Z_quick-install.zip</code>''' (<code>tar.gz</code> archives also exist for GNU/Linux and macOS users). '''It is important that you download the archive named <code>quick-install</code> and not the source code or something else.'''
# Extract this archive somewhere: [[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this: [[File:Ccloader-quick-install.png|class=block-img]] The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>: [[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): [[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:

<source lang="bash">cd /path/to/CrossCode
# TODO update the URL here as well
curl --location --fail 'https://github.com/dmitmel/ccloader3/releases/download/v3.0.0-alpha/ccloader_3.0.0-alpha_quick-install.tar.gz' \
| tar --extract --gzip --verbose --file -</source>

=== 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.

== Method 3: Manual installation of the CCLoader-only package ==

This method is not really intended for regular users, rather this section is a description of the full installation process intended as a reference when implementing tools for automatic CCLoader installation. It is also subject to change in the future, although that's not likely.

# Locate the [[Locations of CrossCode files#Game files folder|CrossCode game files directory]].
# Create a directory for CCLoader files, named, for example, <code>ccloader</code>.
# Download and unpack the release archive named <code>ccloader_X.Y.Z_package.zip</code> or <code>ccloader_X.Y.Z_package.tar.gz</code> into this directory.
# Change the <code>main</code> field in game's <code>package.json</code> from <code>assets/node-webkit.html</code> to <code>ccloader/main.html</code>.
# Create a directory named <code>mods</code> inside game's <code>assets</code>.
# The installation is complete.

[[Category:Modloaders]]