aboutsummaryrefslogtreecommitdiffstats
path: root/desktop/modules/obs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/modules/obs/README.md')
-rw-r--r--desktop/modules/obs/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/desktop/modules/obs/README.md b/desktop/modules/obs/README.md
new file mode 100644
index 0000000..c114192
--- /dev/null
+++ b/desktop/modules/obs/README.md
@@ -0,0 +1,21 @@
+# OBS scenes
+
+The settings page for the island's OBS pill. It edits
+`~/.config/quickshell/obs-scene-icons.json`, the same watched file the pill
+reads, so saving recolours the scene grid with no restart.
+
+One row per scene: the scene name and a field holding its glyph. Find an icon
+on the Nerd Fonts cheat sheet, copy the glyph, and paste it into the field. The
+glyph renders in Inconsolata Nerd Font; one the font lacks shows as tofu, which
+means pick another. A field holds exactly one code point (a supplementary-plane
+glyph is two UTF-16 units); anything longer turns the border red and blocks
+Save.
+
+An empty scene field means "use the generic glyph"; the "Default for unmapped
+scenes" row edits that, and an empty default falls back to `?` so no tile is
+ever blank.
+
+Rows are the configured keys plus whatever scenes OBS reports, so the page
+works with OBS closed for scenes it already knows. A scene created in OBS
+appears once the pill is connected. The JSON can also be hand-edited; the pill
+reloads it.