Files
NewVegasRadio/README.md

91 lines
1.6 KiB
Markdown

# 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
```