CCLoader: Difference between revisions

From CCDirectLink
← Older edit
VisualWikitext
m Image resize
Tag: 2017 source edit
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''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]).
'''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:
There are three ways to perform CCLoader installation, they are both described in this document. But before we continue:
Line 9: Line 11:
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:
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]]
[[File:Github-project-frontpage-releases.png|700px]]


== Method 1: Quick-installation archive ==
== Method 1: Quick-installation archive ==
Line 15: Line 17:
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.
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]].
# 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)
# Go to the [https://github.com/CCDirectLink/CCLoader/releases/latest latest release page] of CCLoader.
# 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.'''
# In the "Assets" list at the bottom of the release click the link which says '''Source code (zip)''' (a <code>tar.gz</code> download also exist for GNU/Linux and macOS users). This will download a quick installation archive.
# Extract this archive somewhere:<br>[[File:Extract-ccloader-quick-install.png|class=block-img]]
# Extract this archive somewhere:<br>[[File:Extract-ccloader-quick-install.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this:<br>[[File:Ccloader-quick-install.png|class=block-img]]<br>The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>:<br>[[File:Ccloader-quick-install-overwrite-package-json.png|class=block-img]]
# Copy the files inside the archive directly into the game folder, like this:<br>[[File:Ccloader-quick-install.png|700px]]<br>The only file you'll have to overwrite in a clean CrossCode installation is the <code>package.json</code>:<br>[[File:Ccloader-quick-install-overwrite-package-json.png|class=block-img]]
# You've now successfully installed CCLoader! The end result should look like (notice the new <code>ccloader</code> folder):<br>[[File:Ccloader-installation-end-result.png|class=block-img]]
# You've now successfully installed CCLoader! The end result should look like (notice the new <code>ccloader</code> folder):<br>[[File:Ccloader-installation-end-result.png|700px]]
# 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]].
# 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]].


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


<source lang="bash">cd /path/to/CrossCode
<syntaxhighlight lang="bash">
# TODO update the URL here as well
cd /path/to/CrossCode
curl --location --fail 'https://github.com/dmitmel/ccloader3/releases/download/v3.0.0-alpha/ccloader_3.0.0-alpha_quick-install.tar.gz' \
# Replace the version in the URL here with the latest one:
   | tar --extract --gzip --verbose --file -</source>
curl --location --fail 'https://github.com/CCDirectLink/CCLoader/archive/refs/tags/v2.20.2/v2.10.1.zip' \
   | tar --extract --gzip --verbose --file -
</syntaxhighlight>


=== Verifying a successful CCLoader installation ===
=== Verifying a successful CCLoader installation ===
Line 36: Line 40:
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:
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]]
[[File:Ccloader-mod-settings-menu.png|700px]]


It will obviously be empty if you haven't [[Installing mods|installed any mods]].
It will obviously be empty if you haven't [[Installing mods|installed any mods]].
Line 44: Line 48:
See https://github.com/CCDirectLink/ccloader-installer. It may be broken though.
See https://github.com/CCDirectLink/ccloader-installer. It may be broken though.


== Method 3: Manual installation of the CCLoader-only package ==
[[Category:Modloaders]]
 
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.

Latest revision as of 00:57, 7 September 2024

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 Rapture + 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!

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:

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.

  1. Obviously, first of all you have to locate the CrossCode game files folder.
  2. Go to the latest release page of CCLoader.
  3. In the "Assets" list at the bottom of the release click the link which says Source code (zip) (a tar.gz download also exist for GNU/Linux and macOS users). This will download a quick installation archive.
  4. Extract this archive somewhere:
  5. Copy the files inside the archive directly into the game folder, like this:

    The only file you'll have to overwrite in a clean CrossCode installation is the package.json:
  6. You've now successfully installed CCLoader! The end result should look like (notice the new ccloader folder):
  7. Mods can be installed into the mods folder located inside assets, for more information on that see the relevant guide.

Bonus for Linux users

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

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 -

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:

It will obviously be empty if you haven't installed any mods.

Method 2: Using the automatic installer

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

Retrieved from "https://wiki.c2dl.info/w/index.php?title=CCLoader&oldid=273"