updated .gitignore, added rust project init, updated README

2026-02-17 23:26:42 +01:00
parent 4c36594391
commit 99efd89abc
4 changed files with 103 additions and 13 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,90 @@
 # NewVegasRadio

+---
+
+### Assets-Directory Structure:
+
+```terminaloutput
+assets/
+    config.(json|toml)
+    songs/
+        my_song/
+            my_song.mp3
+            descriptor.(json|toml)
+            intro/
+                MrNewVegas_N.mp3 (optional)
+            outro/
+                MrNewVegas_N.mp3 (optional)
+    generic/
+        MrNewVegas_N.mp3
+```
+
+---
+
+#### `config.json`:
+```json5
+{
+  "defaults": {
+    "songs_directory":   "songs",
+    "generic_directory": "generic",
+    "log_directory":     "logs",
+    "temp_directory":    "temp"
+  },
+  "settings": {
+    "weight":    1.0,
+    "volume":    1.0,
+    "crossfade": 2.0 // in seconds
+  },
+  "rules": {
+    "shuffle_mode": "weighted", // options: "weighted", "strict_random"
+    "max_same_genre_in_row": 2
+  }
+}
+
+```
+OR
+#### `config.toml`:
+```toml
+[defaults]
+songs_directory   = "songs"
+generic_directory = "generic"
+log_directory     = "logs"
+temp_directory    = "temp"
+
+[settings]
+weight    = 1.0
+volume    = 1.0
+crossfade = 2.0 # in seconds
+
+[rules]
+shuffle_mode          = "weighted" # "weighted", "strict_random"
+max_same_genre_in_row = 2
+```
+
+---
+
+#### `descriptor.json`:
+```json5
+{
+  "title":  "[I Got Spurs That] Jingle, Jangle, Jingle",
+  "artist": "Kay Kyser",
+  "tags":   ["orchestra", "swing", "jazz"],
+  "genre":  ["swing", "jazz"],
+  "intro":  false,
+  "outro":  false,
+  "weight": 1.0, // optional
+  "volume": 1.0, // optional
+}
+```
+OR
+#### `descriptor.toml`:
+```toml
+title  = "[I Got Spurs That] Jingle, Jangle, Jingle"
+artist = "Kay Kyser"
+tags   = ["orchestra", "swing", "jazz"]
+genre  = ["swing", "jazz"]
+intro  = false
+outro  = false
+weight = 1.0 # optional
+volume = 1.0 # optional
+```