updated README

This commit is contained in:
2026-02-21 15:53:46 +01:00
parent df93f93384
commit ead15f54d6

View File

@@ -6,14 +6,14 @@
```terminaloutput
assets/
config.(json|toml)
config.(json|toml|ron)
bin/
x86_64/
aarch64/
songs/
my_song/
my_song.mp3
descriptor.(json|toml)
descriptor.(json|toml|ron)
intro/
Intro_MrNewVegas_my_song.mp3 (optional)
generic/
@@ -100,6 +100,40 @@ recover_after = 5.0
[rules]
shuffle_mode = "weighted" # "weighted", "strict_random"
```
OR
#### `config.ron`
```ron
(
defaults: (
songs_directory: "songs",
generic_directory: "generic",
log_directory: "logs",
temp_directory: "temp",
),
settings: (
debug: true,
weight: 1.0,
volume: 1.0,
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: (
shuffle_mode: weighted, // weighted, strict_random
),
)
```
---
@@ -126,3 +160,16 @@ intro = true
weight = 1.0 # optional
volume = 1.0 # optional
```
OR
#### `descriptor.ron`
```ron
(
title: "[I Got Spurs That] Jingle, Jangle, Jingle",
artist: "Kay Kyser",
tags: ["orchestra", "swing", "jazz"],
genre: ["swing", "jazz"],
intro: true,
weight: 1.0, // optional
volume: 1.0, // optional
)
```