Skip to content
Tomasz Cichoń edited this page Aug 23, 2020 · 13 revisions

Welcome to Centrifuge Project wiki pages. Feel free to look around, educate yourself...
The documentation is still a work-in-progress, things are bound to change, including this very page.

Table of Contents

User Mode

The How

How Centrifuge works
Familiarizing yourself with the entire mod loader initialization process helps both when reporting bugs and creating mods using Centrifuge.

How to Install
Ready to give us a shot? Here's how.

Developer Mode

Mod Development

The Mod Manifest (mod.json)
Best to learn this first, you're not going to be writing a lot of those, but knowledge is power nevertheless.

Getting Started with Mod Development
Crash course into making your own mods for Unity-based games.

Building Centrifuge
Want to contribute? Here's how to build and test the damn thing! Windows and Linux supported!

Game Support Library Development

Game Support Library - Preface
Get to know the responsibilities of a GSL, and why was that concept invented in the first place.

Getting Started with GSL Development
Ready for a deep dive? This is the part where you get your hands dirty, so others don't have to.

Reactor Game Agnostic API Documentation And Examples

Settings System
Learn how to leverage the Reactor Settings System in the best way possible.

Logging System
Need to get something logged? This page has got you covered.

Virtual File System
Manage your mod's data without littering around!

Input System
Bind hotkeys and process input independently of the game. Or integrate the system with that game!

AssetBundle Loader
Game agnostic doesn't mean featureless! Reactor API allows you to load all the resources your mod could possibly need.

Developer Badges

Black on white, black without background
black-on-white black-nobg

Inverse
white-on-black white-nobg