diff --git a/docs/gui.md b/docs/gui.md index 36c6956..9ce08ca 100644 --- a/docs/gui.md +++ b/docs/gui.md @@ -25,8 +25,22 @@ draw_tree --gui This will start a local Streamlit server and automatically open the application in your default web browser at `http://localhost:8501/`. From there, you can: - Upload game files - Tinker with formatting options (e.g., node size, layouts, colors, label backgrounds) -- Download the resulting Tex, SVG, PDF, or PNG images. +- Download the resulting Tex, SVG, PDF, or PNG images, as well as the active rendering configuration. ```{image} ../img/gui_screenshot.png :alt: GUI screenshot -``` \ No newline at end of file +``` + +## Exporting and Reusing Settings + +When you adjust the visual styling of a game in the GUI, you can export these configuration parameters by clicking the **Settings** button in the **Downloads** pane. This downloads a YAML file containing all active styling options (e.g., color schemes, spacing, custom fonts, label offsets). + +### Integration with the Gambit Game Catalog + +If you are a Gambit developer adding new games to the official game catalog, you can use the exported YAML settings to specify how these games should render by default. To do this: + +1. Download the styling configuration file using the **Settings** button. +2. Copy the game's configuration section from the downloaded YAML. +3. Paste or append the configuration under the appropriate key in the master settings file in the Gambit repository: [build_support/catalog/draw_tree_settings.yaml](https://github.com/gambitproject/gambit/blob/master/build_support/catalog/draw_tree_settings.yaml). + +Once added, the game will automatically use your custom styles when displayed in the catalog. \ No newline at end of file