Installing mods - Revision history

Streetclaw: /* Downloading releases */ Resize image

2024-09-06T23:33:58Z

Downloading releases: Resize image

← Older revision		Revision as of 01:33, 7 September 2024
Line 19:		Line 19:
	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:		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~~]]		[[File:Github-mod-releases.png\|900px]]

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

Lexisother: Also explain installation of .ccmod files

2023-04-07T08:19:18Z

Also explain installation of .ccmod files

← Older revision		Revision as of 10:19, 7 April 2023
Line 39:		Line 39:
	== Step 3. Unpack the downloaded mod into your mods folder ==		== 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>.		The title of this step is a bit misleading, because depending on the type of mod you downloaded, you may not even have to extract it.

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

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

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

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

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

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

Dmitmel at 08:42, 11 August 2020

2020-08-11T08:42:06Z

← Older revision		Revision as of 10:42, 11 August 2020
Line 74:		Line 74:
	\| The developer of the mod you are installing likely made a mistake or you downloaded a very old development version of <code>xyz</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]]

Dmitmel at 08:40, 11 August 2020

2020-08-11T08:40:11Z

← Older revision		Revision as of 10:40, 11 August 2020
Line 1:		Line 1:
	~~= 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.		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.

Dmitmel at 08:40, 11 August 2020

2020-08-11T08:40:03Z

← Older revision		Revision as of 10:40, 11 August 2020
Line 7:		Line 7:
	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.		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. [[~~Installing and updating CCLoader\|Install~~ CCLoader]] ==		== 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 [[~~Installing and updating~~ CCLoader\|here]].		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 ==		== Step 2. Get the mod files ==
Line 17:		Line 17:
	=== Downloading releases ===		=== Downloading releases ===

	''See also [[~~Installing and updating~~ CCLoader#VERY IMPORTANT NOTE: Don't use the green "clone or download" button!\|this section]] of the CCLoader installation guide''		''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:		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:

Dmitmel: Created page with "= 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 requi..."

2020-08-11T08:07:54Z

Created page with "= 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 requi..."

New page

= 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. [[Installing and updating CCLoader|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 [[Installing and updating CCLoader|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 [[Installing and updating CCLoader#VERY IMPORTANT NOTE: Don't use the green "clone or download" button!|this section]] of the CCLoader installation guide''

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

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

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

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

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

=== Downloading source code ===

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

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

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

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

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