dotfiles

commit 2c5f0ea754c8e4f859d127a391a41a3aab1ce8db
parent d660d8725152b7e78fcd6df66e8f66b1c63245fb
Author: regexghost <dev@regexghost.com>
Date:   Wed, 19 Aug 2026 16:16:45 +0100

added a buch of comments explaining config files

Diffstat:
M
panel-scripts/metoffice.sh
 | 
3
+++
M
panel-scripts/sunrise.sh
 | 
3
+++
M
terminal-scripts/iphone-music-sync.sh
 | 
8
+++++++-
M
terminal-scripts/soundboard/soundboard.go
 | 
6
++++++
M
terminal-scripts/stream-check.sh
 | 
4
++++
M
wm-scripts/launch-stream.sh
 | 
10
++++++++--

6 files changed, 31 insertions(+), 3 deletions(-)
diff --git a/panel-scripts/metoffice.sh b/panel-scripts/metoffice.sh
@@ -4,6 +4,9 @@
 
 [ -d "/tmp/panel_i3_data" ] || mkdir "/tmp/panel_i3_data"
 
+# Syntax for current_location.csv:
+# `lat|lon`
+
 curLocationFile="$XDG_CONFIG_HOME/regexghost/current_location.csv"
 
 lat=$(cat "$curLocationFile" | cut -d "|" -f 1)
diff --git a/panel-scripts/sunrise.sh b/panel-scripts/sunrise.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Syntax for current_location.csv:
+# `lat|lon`
+
 curLocationFile="$XDG_CONFIG_HOME/regexghost/current_location.csv"
 
 lat=$(cat "$curLocationFile" | cut -d "|" -f 1)
diff --git a/terminal-scripts/iphone-music-sync.sh b/terminal-scripts/iphone-music-sync.sh
@@ -1,5 +1,11 @@
 #!/usr/bin/env bash
 
+# Syntax for playlist csv file:
+# `TerrariaSoundtrack,Terraria Soundtrack`
+# `local-dirname,remote-title`
+
+PLAYLISTS_FILE="$XDG_CONFIG_HOME/regexghost/playlists-phone-sync.csv"
+
 MOUNT_LOCATION="$HOME/Downloads/USBDrive"
 
 # Mount phone
@@ -37,7 +43,7 @@ while read -r line; do
 	# Shuffle into playlist file
 	find "${MOUNT_LOCATION}/${phone}/" -type f | sort | sed "s|.*${phone}/|../${phone}/|g" > "/tmp/${phone}.m3u8"
 	cp "/tmp/${phone}.m3u8" "${MOUNT_LOCATION}/Playlists/"
-done < "$XDG_CONFIG_HOME/regexghost/playlists-phone-sync.csv"
+done < "$PLAYLISTS_FILE"
 
 # Unmount phone
 
diff --git a/terminal-scripts/soundboard/soundboard.go b/terminal-scripts/soundboard/soundboard.go
@@ -24,6 +24,12 @@ var sounds []sound
 
 var cmds []*exec.Cmd
 
+/*
+soundboard.csv:
+`v,Vine boom,wav/vineboom.wav`
+`<key>,<name>,<filename>`
+*/
+
 const CONFIG_FILE=".config/regexghost/soundboard.csv"
 const SOUND_LOC=".local/share/regexghost/sounds"
 
diff --git a/terminal-scripts/stream-check.sh b/terminal-scripts/stream-check.sh
@@ -1,5 +1,9 @@
 #!/bin/sh
 
+# Format for streams.csv:
+# `NerdCubed,nerdcubed,@NerdCubed,NONE`
+# Syntax is: `name,twitch,youtube-at-kick`
+
 CONFIG_FILE="$XDG_CONFIG_HOME/regexghost/streams.csv"
 
 format="pretty"
diff --git a/wm-scripts/launch-stream.sh b/wm-scripts/launch-stream.sh
@@ -1,12 +1,18 @@
 #!/bin/sh
 
+# Format for streams.csv:
+# `NerdCubed,nerdcubed,@NerdCubed,NONE`
+# Syntax is: `name,twitch,youtube-at-kick`
+
+STREAMS_FILE="$XDG_CONFIG_HOME/regexghost/streams.csv"
+
 DMENU_SCRIPT="$XDG_DATA_HOME/regexghost/wm-scripts/dmenu-runner.sh"
 
-stream="$(cat "$XDG_CONFIG_HOME/regexghost/streams.csv" | cut -d "," -f 1 | "$DMENU_SCRIPT" "Select Stream:" -ix)"
+stream="$(cat "$STREAMS_FILE" | cut -d "," -f 1 | "$DMENU_SCRIPT" "Select Stream:" -ix)"
 
 [ "$stream" = "" ] && exit
 
-line="$(sed -n "$((stream+1))p" "$XDG_CONFIG_HOME/regexghost/streams.csv")"
+line="$(sed -n "$((stream+1))p" "$STREAMS_FILE")"
 name="$(echo "$line" | cut -d "," -f 1)"
 twitch="$(echo "$line" | cut -d "," -f 2)"
 youtube="$(echo "$line" | cut -d "," -f 3)"