updated README to current structure, updated .gitignore, added .gitattributes, added bin/ (lfs)

This commit is contained in:
2026-02-19 20:23:23 +01:00
parent 99efd89abc
commit 0f3831275e
17 changed files with 107 additions and 19 deletions

7
.gitattributes vendored Normal file
View File

@@ -0,0 +1,7 @@
* text=auto eol=lf
/.gitignore export-ignore
/.gitattributes export-ignore
*.mp3 filter=lfs diff=lfs merge=lfs -text
assets/bin/** filter=lfs diff=lfs merge=lfs -text

1
.gitignore vendored
View File

@@ -3,6 +3,7 @@
debug/ debug/
target/ target/
assets/.cache
Cargo.lock Cargo.lock

View File

@@ -7,16 +7,37 @@
```terminaloutput ```terminaloutput
assets/ assets/
config.(json|toml) config.(json|toml)
bin/
x86_64/
aarch64/
songs/ songs/
my_song/ my_song/
my_song.mp3 my_song.mp3
descriptor.(json|toml) descriptor.(json|toml)
intro/ intro/
MrNewVegas_N.mp3 (optional) Intro_MrNewVegas_my_song.mp3 (optional)
outro/
MrNewVegas_N.mp3 (optional)
generic/ generic/
MrNewVegas_N.mp3 intro/
Intro_MrNewVegas_N.mp3
news/
story_N/
story.toml (ignored, metadata)
Story_MrNewVegas_N.mp3
Story_Guest_N.mp3
.cache/ (automatically generated)
songs/
my_song/
song.pcm (f32 pcm)
intro.pcm (f32 pcm)
cache.json
generic/
intro/
Intro_MrNewVegas_N.pcm (f32 pcm)
Intro_MrNewVegas_N.cache.json
news/
story_N/
part_N.pcm (f32 pcm)
cache.json
``` ```
--- ---
@@ -33,11 +54,23 @@ assets/
"settings": { "settings": {
"weight": 1.0, "weight": 1.0,
"volume": 1.0, "volume": 1.0,
"crossfade": 2.0 // in seconds "crossfade": 2.0, // in seconds
"weights": {
"news": {
"chance": 0.2
},
"genre": {
"floor": 0.55,
"recover_after": 3.0
},
"composite": {
"floor": 0.05,
"recover_after": 5.0
}
}
}, },
"rules": { "rules": {
"shuffle_mode": "weighted", // options: "weighted", "strict_random" "shuffle_mode": "weighted", // options: "weighted", "strict_random"
"max_same_genre_in_row": 2
} }
} }
@@ -55,10 +88,17 @@ temp_directory = "temp"
weight = 1.0 weight = 1.0
volume = 1.0 volume = 1.0
crossfade = 2.0 # in seconds crossfade = 2.0 # in seconds
[settings.weights.news]
chance = 0.2
[settings.weights.genre]
floor = 0.55
recover_after = 3.0
[settings.weights.composite]
floor = 0.05
recover_after = 5.0
[rules] [rules]
shuffle_mode = "weighted" # "weighted", "strict_random" shuffle_mode = "weighted" # "weighted", "strict_random"
max_same_genre_in_row = 2
``` ```
--- ---
@@ -70,8 +110,7 @@ max_same_genre_in_row = 2
"artist": "Kay Kyser", "artist": "Kay Kyser",
"tags": ["orchestra", "swing", "jazz"], "tags": ["orchestra", "swing", "jazz"],
"genre": ["swing", "jazz"], "genre": ["swing", "jazz"],
"intro": false, "intro": true,
"outro": false,
"weight": 1.0, // optional "weight": 1.0, // optional
"volume": 1.0, // optional "volume": 1.0, // optional
} }
@@ -83,8 +122,7 @@ title = "[I Got Spurs That] Jingle, Jangle, Jingle"
artist = "Kay Kyser" artist = "Kay Kyser"
tags = ["orchestra", "swing", "jazz"] tags = ["orchestra", "swing", "jazz"]
genre = ["swing", "jazz"] genre = ["swing", "jazz"]
intro = false intro = true
outro = false
weight = 1.0 # optional weight = 1.0 # optional
volume = 1.0 # optional volume = 1.0 # optional
``` ```

BIN
assets/bin/aarch64/.env (Stored with Git LFS) Normal file

Binary file not shown.

BIN
assets/bin/aarch64/add_song (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/aarch64/ffmpeg (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/aarch64/ffplay (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/aarch64/ffprobe (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/aarch64/ogg_to_mp3 (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/aarch64/sources.txt (Stored with Git LFS) Normal file

Binary file not shown.

BIN
assets/bin/x86_64/.env (Stored with Git LFS) Normal file

Binary file not shown.

BIN
assets/bin/x86_64/add_song (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/x86_64/ffmpeg (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/x86_64/ffplay (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/x86_64/ffprobe (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/x86_64/ogg_to_mp3 (Stored with Git LFS) Executable file

Binary file not shown.

BIN
assets/bin/x86_64/sources.txt (Stored with Git LFS) Normal file

Binary file not shown.