Merge pull request #2 from GanstaKingofSA/tinytag+2.2

2.2 Update

README.md

@@ -1,29 +1,32 @@
 # DDLC OST-Player
 
-A heavily revamped version of Nikso's Soundtrack Player for DDLC. <u>Current Version:</u> [**2.1**](https://github.com/GanstaKingofSA/DDLC-OSTPlayer/releases/latest)
+A heavily revamped version of Nikso's Soundtrack Player for DDLC.
+
+<u>Current Version:</u> [**2.2**](https://github.com/GanstaKingofSA/DDLC-OSTPlayer/releases/latest)
 
 <p align="center">
-   <img src="assets/screenshot0001.png" alt="New UI" width=420x> 
-   <img src="assets/screenshot0002.png" alt="Old UI" width=420x>
+   <img src=".github/assets/screenshot0001.png" alt="New UI" width=420x> 
+   <img src=".github/assets/screenshot0002.png" alt="Old UI" width=420x>
 </p>
 
 **DISCLAIMER:** This is not afiliated or endorsed by Team Salvato or Nikso. The Scattered Stars <u>Logo</u> in `Wake Up Unchanged` is not free to use, but is only allowed in this build as a display to the soundtrack player. If you plan to use this, remove it in your final build.
 
-> All songs featured above are owned by the developer and are not included in DDLC OST-Player. (Shoo UMG, SME, Rooster Teeth and all other major labels.)
+> All songs featured above are owned by the developer and are not included in DDLC OST-Player. (Shoo UMG, SME, Rooster Teeth and all other music labels.)
 
 ## Credits
 
 - Nikso - Original Developer
 - Sam Kujo#9403 - Original Design and Beta Tester
 - Staryxz#3613 - Original Beta Tester
 - PabloLuaxerc#1719 - Artist of `Wake Up Unchanged`
-- Tom Rothamel - Ren'Py SDK Style Code and Feedback
+- Tom Rothamel - Ren'Py SDK Style Code, Ren'Py File/APK Code and Feedback
+- Tom Wallroth - Tinytag Code
 - RyzekNoavek#0624 - Adjustable Play Bar Code
-- khaase (Pixabay) - Refresh Icon
-- eugenialcala (Pixabay) - Replay Icon
-- raphaelsilva (Pixabay) - Shuffle Icon
-- Josy_Dom_Alexis (Pixabay) - Volume Icon
-- Google - Noto Sans SC Font (Author/Description Tag)
+- khaase (Pixabay) - Refresh Icon (Prior to Version 2.0)
+- eugenialcala (Pixabay) - Replay Icon (Prior to Version 2.0)
+- raphaelsilva (Pixabay) - Shuffle Icon (Prior to Version 2.0)
+- Josy_Dom_Alexis (Pixabay) - Volume Icon (Prior to Version 2.0)
+- Google - Noto Sans SC Font (Author/Description Tag) and Icons (Version 2.0+)
 - Ren'Py Discord - Feedback on Ren'Py Universal Player Feats Now In DDLC OST-Player
 - Weiss Schnee - Support (Weiss :D)
 
@@ -34,15 +37,16 @@ This allows the user to play the soundtrack of mods outside the main story, side
 ## What does this version improve on?
 
 1. Ability to play MP3, OGG, WAV and OPUS files with metadata!
+   > Some players will export music files differently than normal. Make sure your tracks are exported properly using your music player or Audacity.
 2. Improved music player aesthetic.
 3. Dynamic title and font size changes (sort of) and cover art scaling.
 4. Sideload songs from your playlist to be played with the mod's tracks.
-5. RPA/APK Playback and Metadata Support
-   > You will need to enable Developer Mode in order to make the metadata of songs in the track RPA folder generate for distribution.
+5. RPA/APK Playback and Metadata Support!
 6. Improved fonts for some languages. See a example [here.](assets/screenshot0006.png)
 
-    > Due to languages and font character limits, the fonts in DDLC OST-Player will not cover all languages. Riffic-Bold will have to be downloaded separately to comply with the FontSpring license.
-7. Android Support!
+   > Due to languages and font character limits, the fonts in DDLC OST-Player will not cover all languages. Riffic-Bold will have to be downloaded separately to comply with the FontSpring license.
+
+7. Android Support! (Ren'Py 7 Required)
 
 ## What do I need to run this?
 
@@ -57,20 +61,19 @@ This allows the user to play the soundtrack of mods outside the main story, side
 
 > This assumes you already have a copy of DDLC with the mod template installed over it.
 
-1. Drop all the contents in this ZIP file into the `game` folder.
-   > If you are on MacOS/OS X, you must right-click DDLC.app and click `Show Package Contents` then navigate to `Contents/Resources/autorun/game` and drop the ZIP file contents in there.
-2. Open *options.rpy* and add the following lines under line `192`
+1. Drop all the contents in this ZIP file into the base folder of DDLC (where `DDLC.exe`/`DDLC.sh` is).
+   > If you are on MacOS/OS X, you must right-click DDLC.app and click `Show Package Contents` then navigate to `Contents/Resources/autorun` and drop the ZIP file contents in there.
+2. Open _options.rpy_ and add the following lines under line `192`
    ```py
-   build.classify("game/RPASongMetadata.json", "scripts all")
-   build.classify("game/python-packages/**", "mod")
+   build.classify("game/python-packages/**", "mod all")
    ```
-3. Copy this line to *screens.rpy* under `textbutton _("Load Game")` and restart DDLC.
+3. Copy this line to _screens.rpy_ under `textbutton _("Load Game")` and restart DDLC.
    ```py
-   textbutton _("Music Room") action [ShowMenu("music_player"), Function(get_music_channel_info), Stop('music', fadeout=2.0), Function(refresh_list)]
+   textbutton _("Music Room") action [ShowMenu("music_player"), Function(ost_start), Stop('music', fadeout=2.0)]
    ```
-3. **(Recommended but Optional)** Download the `Riffic-Bold` font from [Fontspring](https://www.fontspring.com/fonts/inky-type/riffic/riffic-bold) and copy the `riffic-bold.ttf` in _Fonts_ to `game/mod_assets/music_player`
-   - Open *audio_player.rpy* and remove the `#` symbol in front of lines `292` and `299`.
-4. Put music in the `track` folder inside the `game` folder and try it out!
+4. **(Recommended but Optional)** Download the `Riffic-Bold` font from [Fontspring](https://www.fontspring.com/fonts/inky-type/riffic/riffic-bold) and copy the `riffic-bold.ttf` in _Fonts_ to `game/mod_assets/music_player`
+   - Open _audio_player.rpy_ and remove the `#` symbol in front of lines `292` and `299`.
+5. Put music in the `track` folder inside the `game` folder and try it out!
 
 ## Can I still define songs the old way?
 
@@ -82,13 +85,13 @@ manualDefineList.append(Wake_Up_Unchanged)
 
 > Change `Wake_Up_Unchanged` to your song variable
 
-Additionally you may use `unlocked` to lock some songs from playing until the player hears it in-game. See *manualtracks.rpy* for a example.
+Additionally you may use `unlocked` to lock some songs from playing until the player hears it in-game. See _manualtracks.rpy_ for a example.
 
-> It is now recommended to move all the manual defines to *manualtracks.rpy* for easier define access versus doing so in *audio_player.rpy*.
+> It is now recommended to move all the manual defines to _manualtracks.rpy_ for easier define access versus doing so in _audio_player.rpy_.
 
 ## How do I priortize a song or make a song the first one?
 
-Manually define your song and give it a priority value. 0 is the highest priority you can make a song be while 1, 2, etc. will be prioritzed lower in the list. i.e. *0 > 1 > 2 > ...*
+Manually define your song and give it a priority value. 0 is the highest priority you can make a song be while 1, 2, etc. will be prioritzed lower in the list. i.e. _0 > 1 > 2 > ..._
 
 ## Why is `Riffic-Bold` not included in DDLC OST-Player?
 
@@ -102,6 +105,9 @@ Alternatively, use [MusicBee](https://www.getmusicbee.com/) or a similar music p
 - For MusicBee: Right-Click your song within the player, select _Edit_ and edit away the info you want, then click _Apply_ then _OK_.
 - For MusicBrainz Picard: Add your song to Picard, select it, right-click the rectangle box that has 3 columns, select _Add New Tag_, select the tags you want to add like _Title_, _Artist_, _Comment_, _Album_, etc. There should be a blank box in the box area below, double-click it and edit away the info you want to add, then click _Save_ and press the _Save_ button near _Info_.
 
+## Why Ren'Py 7 only for Android?
+Ren'Py 6 has funky code in Android which causes it to not read sideloaded files. <u>Files defined within the game can still be played however.</u>
+
 ## Why did you do this?
 
 Cause I was bored and wanted to see RWBY songs play within DDLC and see song covers displayed. (Yang _:P_)