CoreLib

CORELIB

A modding library for Core Keeper. Provides features that makes modding Core Keeper easier.

WARNING! Version 4.0.0 contains breaking changes.

LIST OF FEATURES

• Custom items, blocks, enemies, NPC, etc.
• Easier access to Rewired input system, localization
• Custom chat commands

And much more!

DEVELOPING WITH CORELIB

To develop with CoreLib, you will need to install CoreLib package into your mod SDK project.

PREPARATION

CoreLib packages use git packages, this means you MUST install git and add it to your PATH environment variable.

Note:

• After installing git make sure to close Unity and Unity hub completely!
• Unity Hub does not close when you close the window and needs to be exited from the Windows Notification Area

INSTALLATION

Navigate to your mod SDK project root, and open Packages folder. And edit manifest.json file with your favorite text editor.

Add following line at the beginning:

"ck.modding.corelib": "https://github.com/CoreKeeperMods/CoreLib.git?path=/Assets/CoreLibPackage#4.0.0",

If you want to install latest version of CoreLib use #main at the end of every line. However it is highly recommended that you lock your version, and update it manually. To do that replace #main with #tag. For example #4.0.0.

DONE

Now you can open your project and you will have Core Lib ready to be used.

You can access CoreLib documentation from within your editor, by navigating to CoreLib package folder and viewing README.md

UTILITIES

With Core Lib Package also comes a few useful editors:

• Select dependencies from a dropdown (Including CoreLib)
• Updating asmdef file accordingly to your dependency declaration
• Building Burst assembly with your mod
• Migrating Localization.csv to DataBlocks

DOCUMENTATION

Documentation can be found here: https://corekeepermods.github.io/#/