fix: sort song cover files for consistent behavior in CI/CD

- Add sorting to get_song_cover_path() to ensure deterministic file selection - Clean up README formatting and add section headers
thomasasfk · Nov 8, 2024 · b846583 · b846583
1 parent 7101be9
commit b846583
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -4,63 +4,58 @@ Convert data of [DANCERUSH STARDOM](https://remywiki.com/AC_DRS) tracks into [Da
 
 Curious? @thomasasfk on discord
 
-### Download the tracks here:
+## Quick Start (Players)
 
+### Download the tracks here:
 - https://mega.nz/file/KbB1DSjb#_sepIa5KmyWVChnCMyaZxqztzQuXXDI3AMgXEdpR7-8 (all songs)
 
----
-
-### How do I install these?
+### How to Install:
+1. Right click Dance Dash on Steam
+2. Click Manage > Browse local files (will open explorer)
+3. Drag `DANCERUSH_STARDOM.zip` into the folder
+4. Right click > Extract Here (7zip)
 
-- Right click Dance Dash on Steam
-- Manage > Browse local files (will open explorer)
-- Drag `DANCERUSH_STARDOM.zip` into the folder
-- Right click > Extract Here (7zip)
-
-Note, if you don't use 7zip - you may need to drag the folder manually.
+Note: If you don't use 7zip, you may need to drag the folder manually.
 
 Target directory for Custom Albums is: `steamapps\common\Dance Dash\Dance Dash_Data\StreamingAssets\NewDLC`
 
-
 ---
 
-### Setup:
+## Development Setup (Only needed if modifying/creating beat maps)
+
+If you just want to play the songs, you can ignore everything below this section. The following instructions are only necessary if you want to modify existing beat maps or create new ones.
 
-- Install Python 3.10 (pyenv recommended)
+### Prerequisites:
+- Python 3.10 (pyenv recommended)
 
-- Install the required Python packages
+### Install Development Dependencies:
 ```bash
 python -m venv .venv
 . .venv/bin/activate # or .venv\Scripts\activate.bat on Windows
 python -m pip install -r requirements.txt
 ```
 
-- Install pre-commit hooks
+### Install pre-commit hooks:
 ```bash
 pre-commit install
 ```
 
----
-
-### Usage:
-
-Generate json files from xml files (needs xml files and a brave soul)
+### Development Usage:
 
+Generate json files from xml files (needs xml files):
 ```bash
 HAS_XML=1 .venv/Scripts/python drsxml2json.py
 ```
 
-Generate full DD Beat Map from json files in repository (no --song-id does all)
-
+Generate full DD Beat Map from json files in repository (no --song-id does all):
 ```bash
 .venv/Scripts/python drs2dd.py --song-id 187
 ```
 
-Generate full DD Beat Map from Feet Saber directory (WIP)
-
+Generate full DD Beat Map from Feet Saber directory (WIP):
 ```bash
 .venv/Scripts/python fs2dd.py --fs-map-dir "path/to/map/folder"
 .venv/Scripts/python fs2dd.py --fs-map-id 229ed
 .venv/Scripts/python fs2dd.py --fs-map-ids 229ed,299b5
 .venv/Scripts/python fs2dd.py --fs-playlist-id 3474
-```
+```
diff --git a/util.py b/util.py
@@ -34,9 +34,9 @@ def get_drs_ogg_and_duration(folder_path) -> tuple[str, str] | tuple[None, None]
 
 
 def get_song_cover_path(folder_path) -> str | None:
-    cover_files = [
+    cover_files = sorted([
         f for f in os.listdir(folder_path) if f.startswith('jk_') and f.endswith('_b.png')
-    ]
+    ])
     if not cover_files:
         return None