wyj/katrain-qt
1
0 Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Minor improvements to theme docs (#713)

Browse Source 
* Minor improvements to theme docs

At some point the theme file went to JSON but the territory examples were still in python. Also, `theme-<whatever>.json` is better.

* remove highlighting

The comments and examples are useful but not valid json - it's okay to just not use syntax highlighting I think.
This commit is contained in:
Miles Crawford authored and GitHub committed 2024-09-29 11:06:04 +02:00
1 parent cf8ca1ae41
commit 409a16b769
1 file changed
+9 -7
Download Patch File Download Diff File Expand all files Collapse all files
THEMES.md
+9 -7
View File
@@ -5,7 +5,7 @@ Version 1.7 brings basic support for themes, and 1.9 extends it to include keybo
## Creating and editing themes ## Creating and editing themes
* Look at the `Theme` class in [`katrain/gui/theme.py`](https://github.com/sanderland/katrain/blob/master/katrain/gui/theme.py). * Look at the `Theme` class in [`katrain/gui/theme.py`](https://github.com/sanderland/katrain/blob/master/katrain/gui/theme.py).
* Make a `theme<yourthemename>.json` file in your `<home dir>/.katrain` directory and specify any variables from the above class you want to override, e.g. * Make a `theme-<yourthemename>.json` file in your `<home dir>/.katrain` directory and specify any variables from the above class you want to override, e.g.
```json ```json
{ {
"BACKGROUND_COLOR": [1,0,0,1], "BACKGROUND_COLOR": [1,0,0,1],
@@ -41,12 +41,14 @@ Version 1.7 brings basic support for themes, and 1.9 extends it to include keybo
The stone marks, transparency, and territory style are independent; the table above presents a collection of possible variants. The stone marks, transparency, and territory style are independent; the table above presents a collection of possible variants.
The relevant variables are: The relevant variables are:
``` ```
TERRITORY_DISPLAY = "blended" | "shaded" | "marks" | "blocks" {
STONE_MARKS = "all" | "weak" | "none" "TERRITORY_DISPLAY" : "blended" | "shaded" | "marks" | "blocks",
OWNERSHIP_COLORS = {"B": [0.0, 0.0, 0.10, 0.75], "W": [0.92, 0.92, 1.0, 0.800]} "STONE_MARKS" : "all" | "weak" | "none",
BLOCKS_THRESHOLD = 0.6 "OWNERSHIP_COLORS" : {"B": [0.0, 0.0, 0.10, 0.75], "W": [0.92, 0.92, 1.0, 0.800]},
MARK_SIZE = 0.42 # as fraction of stone size "BLOCKS_THRESHOLD" : 0.6,
STONE_MIN_ALPHA = 0.5 "MARK_SIZE" : 0.42, # as fraction of stone size
"STONE_MIN_ALPHA" : 0.5
}
``` ```
The colors are specified as RGB values and a maximum alpha transparency. The colors are specified as RGB values and a maximum alpha transparency.