Basic¶

This will cover the basic information for code.

General tips¶

Ways to find things in the codebase if you don’t know where they are¶

Ctrl + Shift + F (search all files in project for keywords)
Ctrl + left click(follow function calls and class initializations to their definitions)
If you’re trying to find code for what happens on a screen in response to clicking something, check the screen’s handle_event() function for what code runs when that button is pressed
Keep playing around with fixing bugs or adding new features. Eventually you’ll develop an intuition for where things will probably be in the codebase

Bug Reporting¶

Game Config¶

The game config, found locally in resources/game_config.toml, holds several development settings that are used within ClanGen. These settings are used to control the chance of events, relationship values, patrol generation, and more. There are many debug settings, usually prepended with debug_, that will help you test code and content more easily.

Please see the game config file for more details. What settings do is specified in the file.