This wiki is archived from 2021-09-05
Client mods are mounted (loaded) on the client and change the local experience for a player.
Client mods are NOT mounted for all players and cannot change units or unit specs in a game.
Client Mod Types
There are four basic types of client mods:
- user interface (UI)
- unit build
- map packs (currently a special type of UI client mod)
Examples of UI client mods are:
- add xmpp multi-user chat rooms to the uberbar scene
- add shared maps to the load planet scene
Example of effects mods are:
- change weapon effects to show more clearly what is shooting at you
Examples of unit build client mods are:
- change the area build of mines from a circle to a strip four wide
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.
Biome Server Mods
A companion mod can also be used when a biome server mod requires a client mod to be loaded.