This wiki is archived from 2021-09-05
Template:Companion Mods: Difference between revisions
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== | == Companion Mods == | ||
Companion mods are a special type of client mod that | Companion mods are a special type of client mod that server mods can specify to force loading of a client mod when connecting to a game. | ||
When a companion mod is required they are automatically: | When a companion mod is required they are automatically: | ||
| Line 12: | Line 8: | ||
* updated if existing download is out of date | * updated if existing download is out of date | ||
* activated (mounted) only for the current game | * activated (mounted) only for the current game | ||
=== Large Server Mods === | |||
A companion mod can be used to reduce the size of large server mods by splitting client files into a separate client mod. | |||
Files not needed on the server are moved into a companion client mod to make uploading and downloading of the server mod faster. | |||
The trade off is that the server mod no longer contains all files required to join, spectate or watch a replay of the game that used the server mod. ie the companion must be available to watch historical replays. | |||
[[Server_Mods#Large_Server_Mod_Recommendations|Large_Server_Mod_Recommendations]] | |||
=== Biome Server Mods === | |||
A companion mod can also be used when a biome server mod requires a client mod to be loaded. | |||
Latest revision as of 08:40, 9 September 2021
Companion Mods
Companion mods are a special type of client mod that server mods can specify to force loading of a client mod when connecting to a game.
When a companion mod is required they are automatically:
- downloaded if not in downloads cache
- updated if existing download is out of date
- activated (mounted) only for the current game
Large Server Mods
A companion mod can be used to reduce the size of large server mods by splitting client files into a separate client mod.
Files not needed on the server are moved into a companion client mod to make uploading and downloading of the server mod faster.
The trade off is that the server mod no longer contains all files required to join, spectate or watch a replay of the game that used the server mod. ie the companion must be available to watch historical replays.
Large_Server_Mod_Recommendations
Biome Server Mods
A companion mod can also be used when a biome server mod requires a client mod to be loaded.