Nickel-Nickel icon

Nickel

A modding API / mod loader for the game Cobalt Core by Rocket Rat Games.

Last updated 9 months ago
Total downloads 512
Total rating 2 
Categories Tools
Dependency string Nickel-Nickel-0.7.0
Dependants 0 other packages depend on this package

README

Nickel

Nickel is a modding API / mod loader for the game Cobalt Core by Rocket Rat Games. It is completely independent from the main game and does not modify any of its files.

The main purposes of Nickel are:

  1. Be completely independent from the game. Nickel does not modify any game files or use the same save files -- if the user wants to, they can still launch the vanilla game with the progress they already had.
  2. Resolve and load mods. Nickel finds all mods in a given folder, automatically determines their load order based on their dependencies, and finally loads the mods in that order. Depending on the mods' needs, they can load in one of the predefined phases -- before the game's code gets loaded, after it is loaded, or after the game initializes its database.
  3. Set up common utilities for mods. These utilities include but are not limited to: Harmony, Mono.Cecil, Shrike.
  4. Expose the ability to edit the game's code before it gets loaded. Combining the Mono.Cecil library and being able to load before the game's assembly lets mods do some normally impossible things by directly editing the game's code before it even gets a chance to get loaded.
  5. Capture logs useful for debugging issues. Nickel will capture all kinds of logs in one common file. This includes any actions Nickel does, anything mods log by themselves, and anything the game logs. All of this information together can help figuring out issues specific to the modded game.
  6. [Experimental] Automatically fix save files. Nickel will try to recover a save file from being completely unusable. This can often happen when adding, removing or updating mods.

Documentation

For players

Other