CCLoader - Revision history

Streetclaw: Image resize

2024-09-06T23:57:19Z

Image resize

Lexisother: Move the codeblock to the not-deprecated syntaxhighlight

2023-05-25T13:43:19Z

Move the codeblock to the not-deprecated syntaxhighlight

← Older revision		Revision as of 15:43, 25 May 2023
Line 29:		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">
			cd /path/to/CrossCode
	# Replace the version in the URL here with the latest one:		# 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' \		curl --location --fail 'https://github.com/CCDirectLink/CCLoader/archive/refs/tags/v2.20.2/v2.10.1.zip' \
	\| tar --extract --gzip --verbose --file -</~~source~~>		\| tar --extract --gzip --verbose --file -
			</syntaxhighlight>

	=== Verifying a successful CCLoader installation ===		=== Verifying a successful CCLoader installation ===

Dmitmel: Remove info about v3 until it is released

2021-10-10T11:50:55Z

Remove info about v3 until it is released

← Older revision		Revision as of 13:50, 10 October 2021
Line 17:		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\|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]]
Line 30:		Line 30:

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

Line 45:		Line 45:

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

	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]]		[[Category:Modloaders]]

Dmitmel: Undo revision 84 by Dmitmel (talk)

2020-08-12T10:07:32Z

Undo revision 84 by Dmitmel (talk)

← Older revision		Revision as of 12:07, 12 August 2020
Line 58:		Line 58:

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

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

2020-08-12T10:05:25Z

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

← Older revision		Revision as of 12:05, 12 August 2020
Line 58:		Line 58:

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

Dmitmel: Link to the wiki pages of modloaders

2020-08-11T11:14:16Z

Link to the wiki pages of modloaders

← Older revision		Revision as of 13:14, 11 August 2020
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 =		= Installation =

Dmitmel at 08:29, 11 August 2020

2020-08-11T08:29:15Z

← Older revision		Revision as of 10:29, 11 August 2020
Line 56:		Line 56:
	# Create a directory named <code>mods</code> inside game's <code>assets</code>.		# Create a directory named <code>mods</code> inside game's <code>assets</code>.
	# The installation is complete.		# The installation is complete.

			[[Category:Modloaders]]

Dmitmel at 08:23, 11 August 2020

2020-08-11T08:23:18Z

← Older revision		Revision as of 10:23, 11 August 2020
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], [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:		There are three ways to perform CCLoader installation, they are both described in this document. But before we continue:

Dmitmel: Dmitmel moved page Installing and updating CCLoader to CCLoader

2020-08-11T08:19:35Z

Dmitmel moved page Installing and updating CCLoader to CCLoader

← Older revision	Revision as of 10:19, 11 August 2020
(No difference)

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

2020-08-11T07:36:50Z

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

← Older revision		Revision as of 09:36, 11 August 2020
Line 3:		Line 3:
	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:

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

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

← Older revision		Revision as of 01:57, 7 September 2024
Line 11:		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 21:		Line 21:
	# 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.		# 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 40:		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]].