Skip to main content

Need a powerful server for your projects?

Discover our offers

Install mod.io mods

Core Keeper has official mod support through mod.io, available from within the game. On a dedicated server, mods are installed by uploading their files to the server. Before installing anything, you need to understand where each mod has to run.

Server mods vs client mods: what you need to know​

Mod typeExamplesOn the serverFor players
Client-onlyInterface, display, visual comfort, minimapNo: useless, and can even cause errorsYes, for those who want it
Shared contentNew items, blocks, enemies, recipesYesYes, on the same version
Server-onlyGameplay settings enforced by the serverYesNo, if the author says so
Not every mod works on a dedicated server

Some mods are client-side only and aren't meant for a dedicated server. Check each mod's mod.io page before installing it: the author usually states whether it supports dedicated servers, whether players need to install it, and which dependencies it requires.

When in doubt, remember this: a mod that adds content (items, blocks, creatures) almost always has to be present both on the server and for every player, on the same version.

Getting a mod's files​

Two options, depending on the mod:

  • From the mod's mod.io page, when a manual download is offered
  • From your PC, after subscribing to the mod in the game: mods downloaded by Core Keeper are stored in a mod.io folder on your PC (on Windows, usually under C:\Users\Public\mod.io\). Each mod has its own subfolder

Also mind the dependencies: many mods require a shared library (CoreLib, for example) that must be installed as well, on the server and for players.

Where to install mods on the server​

Mods go into the Mods/ folder of the server data, usually:

CoreKeeperServer_Data/StreamingAssets/Mods/
├── MyMod/
│   └── ...
└── CoreLib/
    └── ...

Create the Mods/ folder if it doesn't exist. Each mod has its own subfolder. The exact location may vary with the game version: follow the mod author's instructions first.

The double folder trap

An extracted archive often gives Mods/MyMod/MyMod/.... One extra folder and the mod may be ignored with no visible error. Make sure the mod's files sit directly in Mods/MyMod/.

Installation steps​

  1. Check on mod.io that the mod supports dedicated servers and your version of Core Keeper
  2. Log in to your Game Panel: game.yorkhost.fr
  3. Select your server and stop it
  4. Take a backup from the Backups tab (see Backups)
  5. In the Files tab, open (or create) the Mods/ folder
  6. Upload the mod folder and its dependencies: upload the .zip archive then extract it, or transfer the folder over SFTP (credentials under Settings → SFTP Details, see SFTP extension for VSCode)
  7. Start the server and watch the Console
  8. Ask your players to install the same mods, on the same version (subscribe on mod.io from within the game)

Checking that the mod is loaded​

At startup, the server usually lists the mods it loads in the console, along with any loading errors. Look for your mod's name in the startup lines. If there's an error, note the exact message: that's the information to pass on to the mod author or to our support.

Then check the effect in game (new item, new recipe…).

Uninstalling a mod​

  1. Stop the server
  2. Delete the mod's folder in Mods/
  3. Start the server
Removing a content mod mid-game

Removing a mod that adds items or blocks can make things already placed or stored in the world disappear, or even stop the world from loading. Back up first, and for big changes, consider starting a new world.

Good practices​

  • Add mods one at a time and start the server after each one: you'll know right away which one causes trouble.
  • After a game update, check each mod's compatibility before restarting: a mod that hasn't been updated yet can prevent startup.
  • Mods increase RAM usage: for a modded server, an Octarine or Galaxite plan is recommended (see Getting started).

See also​