Skip to content

CentriFuGe Docs

!!! note "Current Status" CentriFuGe is in early development, and currently at the prototype stage. Consider looking through the plans, showing your support, and get involved in the development direction. However, avoid forming any projects around CentriFuGe yet.

Welcome to the documentation for CentriFuGe, the open source framework for creating deterministic card game logic for your Godot card game.

This framework is for anyone wanting to create a virtual card game. Whether the game uses the traditional 52 card deck, or more modern variants like Balatro, Slay the Spire, or Hearthstone. CentriFuGe provides underlying logic to your game, such as turn orders, undo/redo, passing turns, limiting the types of moves available.

CentriFuGe is currently in a very early development state. It is possible to play games from start to finish (see the example Mau-Mau game), but lacks polish and additional features.

Why consider CentriFuGe? This framework is open source, and developed with the Godot community in mind. Have a feature you're looking for? Let it be known. By handling the logic of the game, it frees up development time so you can focus on the visuals and core gameplay of your game.

Features:

  • Undo/Redo actions built in.
  • Player Turns, Game phases, and complex rule structures
  • Move Logging and time-travel to previous states
  • Debug prototyping interfaces for simulating moves without the need for designing visuals.

2D card game example with CetriFuGe debug window

Get Started

Download

Visit Codeberg, the site that hosts the code, or download the zip here. Once extracted, that is a ready-to-go project you can open in Godot.

Or, if you already have a project and want to add the framework, that it also possible. Step 1) Copy the cardgameframework folder from within the zip to your project. Step 2) Add GameManager.gd as an autoload (project settings -> autoload).

Example Card Game

An example already-implemented card game is in the games folder. This game is "Mau-Mau", also refered to as "uno" or "black fives". The objective is to empty your hand, taking turn to match the previous card, either by suit or value.

Learn more

To get learn how the framework functions, check out the core concepts and tutorial. If you know what this framework can do for you, check out guides for more detailed specifics.