KristyF/PartyJukebox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme to match new generator use

Browse source
This commit is contained in:
Kristy Fournier 2025-03-05 11:15:33 -05:00
parent 968d30897e
commit 9a3008b29e
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
readme.md
View file

@ -49,18 +49,19 @@ These are specific details on each section of the app, and how to use them
- Running with `--directory (directoryOfmp3s)` allows for sound files to be in a different place - Running with `--directory (directoryOfmp3s)` allows for sound files to be in a different place
- Default `"./sound"` - Default `"./sound"`
- _This setting might be kinda iffy on Linux. You're on Linux just go and edit it if you have issues_ - _This setting might be kinda iffy on Linux. You're on Linux just go and edit it if you have issues_
- __Make certain you only use forward slashes in your directory, even on Windows__ - ~~__Make certain you only use forward slashes in your directory, even on Windows__~~ I think this should be fine now i'll check later
- `songDatabase.json` stores all the information about each song in this format: - `songDatabase.json` stores all the information about each song in this format:
``` ```
[ {
{ "songDirectory": "./sound/",
"file": "The Search_NF.mp3", "songData": {
"title": "The Search", "Circus_Fox Szn.mp3":
"artist": "NF", {"title": "Circus",
"art": "https://lastfm.freetls.fastly.net/i/u/64s/03125956378d531a44e1b7da89aae795.png", "artist": "Fox Szn",
"length": 292 "art": null,
"length": 141}
} }
] }
``` ```
- `webbyBits.py` imports the database, runs all music playing, and accepts all commands from clients - `webbyBits.py` imports the database, runs all music playing, and accepts all commands from clients
- Searches return matching songs - Searches return matching songs