Home

Introduction

The Ouroboros King Modding Documentation

This documentation is intended to help you understand how to mod The Ouroboros King and create your own mods.
There are two types of mods:

• Text Mods: These mods add new content to the game through text data.

• Script Mods: These mods add new content to the game through C# scripts.

Text mods are files in YAML, JSON, or CSV format that are loaded by the game. They generally require no programming knowledge to create, but are more limited in what they can do.
Script mods are compiled DLL files that are loaded by the game. They require programming knowledge to create, but can do more than text mods.

Getting Started

Mod support is built into The Ouroboros King, so no additional tools are required to create mods.
To get started with creating mods, you will need to:

1. Create a subfolder in the Mods folder: This is where your mod files will be stored. Placing it in the root folder is also possible, but not recommended. The Mods folder can be in either of the following locations:

   
   

   Documents\The Ouroboros King\Mods (This is the documents folder defined by the OS)

   
   

   The Ouroboros King\The Ouroboros King_Data\Mods (This is the game's data in the installation folder. Use Browse Local Files in Steam to find it. Note that Mac uses Contents instead of The Ouroboros King_Data.)

2. Add your mod files: Create your mod files in the subfolder you created. See the documentation for the specific type of mod you are creating for more information on how to create them.

3. Run the game: Your mod should be loaded automatically when you run the game. If it is not, check the log file by clicking the Mods button in the main menu.

Current Modding Features

Currently, only custom pieces and piece overrides are supported. Depending on how much interest there is in modding, more features may be added in the future.

Documentation

• Text Mods

• Script Mods

Support

If you need help with modding, you can ask for help in the Oriol Cosp Discord server. You can also give suggestions, report bugs, or propose changes to the modding system or documentation there.