Skip to content

Game Preferences

Cromha edited this page Apr 6, 2024 · 13 revisions

Introduction

As mods, preferences are a YAML file. There are a few options at this time of development, but they're will be more in the future. You can either edit the preferences by opening the preferences.yaml in the game config folder with your favorite text editor; or edit it within your terminal/game by choosing the Preferences option in the game main menu. You'll then have the choice to use the GUI editor, or a text editor. The GUI editor is simpler to use, and you have to possibility to enable or disable plugins.

Opening within the game/terminal:


image


Preferences

Here is how to game preferences.yaml configuration should look:

latest preset:
  plugin: <plugin name | none(str)>
  save: <save name(str)>
  type: <vanilla | plugin(str)>
speed up: <false | true(bool)>
theme: <fade theme(str)>
title style: <digit(0<int<3)>
auto update: <true | false(bool)>
logging level: <level(0<int<4)>
game data download:
  branch: <commit | branch name | tag name(str)>
  org: <github account or organization name(str)>
  repository: <repository name(str)>
  • The latest preset dictionary should not be modified. It is automatically updated every time you launch the game. But if you're wondering how it works:
    • plugin // The latest plugin you used. If the type key is set to vanilla, it will be ignored
    • save // The name of the latest save opened. If the save is save_Cromha.yaml, then here it will be written only Cromha.
    • type // It's whether you opened the game with vanilla of plugin data.
  • speed up // If it is set to True, all text with speech text effects will not have speech text effects and the game loading screen will not appear. It has been made for contributors.
  • theme // It's which fade to use for the game title in the main menu. You can find all possibilities here : https://pypi.org/project/fade/
  • title style // This parameter is deprecated and should not be modified. If you're wondering what it is for; if the title style key as a value of 3 as example, then it will use the imgs/Title3 for the game title in the main menu.
  • auto update // If set to true, the game will always try to update your game config folder. This also makes the game update/download the required python module requirements at every launch of the program.
  • logging level // A value that determines the logging level: 1=full; 2=no info; 3=only errors.
  • game data download // this defines from which branch/commit/tag, repository and github account the game data will be downloading at the beginning of the program, if auto update is set to true.
    • branch // the github commit or branch/tag name
    • org // the github account or organization name
    • repository // the github repository name
Clone this wiki locally