Skip to content

Commit 66dfa32

Browse files
Update docs to: Add theme changing support at runtime (#100)
1 parent 2973280 commit 66dfa32

2 files changed

Lines changed: 43 additions & 0 deletions

File tree

docs/themes.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Themes in Text Forge
2+
Text Forge supports customizable themes for UI elements. This page explains how themes work, how to
3+
create your own, and how to install or share them.
4+
5+
## Theme Structure
6+
Each theme is defined as a `.tres` file. This file is a Godot (text-based) resource in INI style.
7+
You can style UI elements with this file.
8+
9+
## Getting Themes
10+
Text Forge has some internal themes:
11+
12+
- Dark (default) `dark`
13+
14+
You can find other themes here:
15+
16+
- [Text Forge awsome themes](https://text-forge.github.io/awsome-themes)
17+
18+
## Installing Themes
19+
To install a theme, open **Settings > Open Data Folder**, go to the `themes/` folder, and paste the
20+
`.tres` file there.
21+
22+
!!! Note
23+
24+
You can use installed themes without restarting the editor.
25+
26+
## Changing Editor Theme
27+
To change the theme, go to **Settings > Preferences > Editor UI > Theme Name**, enter the theme file
28+
name (without the extension), and close the Preferences window. The editor will load the new theme.
29+
30+
## Creating a Theme
31+
If you want to create themes, use the Godot editor. See the guide for opening the Text Forge source
32+
in Godot:
33+
34+
- [Build Text Forge from source](build.md)
35+
36+
Then edit `res://data/themes/dark.tres` in the Godot Theme Editor or create a new theme in that
37+
folder. When your theme is complete, rename it and share it. You can test it directly; the editor
38+
copies `res://data/themes/` to `user://themes/` when you run it.
39+
40+
## Themes Location
41+
The editor loads all themes from the `themes/` folder in the editor data directory. Internal themes
42+
live at `res://data/themes/`.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ nav:
2626
- Setup: setup.md
2727
- Guides:
2828
- Menus: menus.md
29+
- Themes: themes.md
2930
- Architecture:
3031
- Data Driven UI: data_driven_ui.md
3132
- Object Oriented Design: object_oriented_design.md

0 commit comments

Comments
 (0)