Merge pull request #3 from GanstaKingofSA/3.0

3.0 Feat

.gitignore

@@ -1,2 +1,3 @@
 DDLC-OSTPlayer-*.zip
-mod_assets/music_player/riffic-bold.ttf
+riffic-bold.ttf
+new_audio_player.rpy

README.md

@@ -1,113 +1,86 @@
-# DDLC OST-Player
+# DDLC OST Player
 
 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)
+[Download DDLC OST-Player Here!](https://github.com/GanstaKingofSA/DDLC-OSTPlayer/releases/latest) 
 
 <p align="center">
-   <img src=".github/assets/screenshot0001.png" alt="New UI" width=420x> 
-   <img src=".github/assets/screenshot0002.png" alt="Old UI" width=420x>
+   <img src=".github/assets/OSTPlayerLogo.png" alt="OST Player Logo" width=240x> 
 </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.
+**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 music labels.)
+## What is DDLC OST Player?
+This allows the user to play the mods' soundtrack alongside a players' own music outside the main story.
 
-## 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, Ren'Py File/APK Code and Feedback
-- Tom Wallroth - Tinytag Code
-- RyzekNoavek#0624 - Adjustable Play Bar Code
-- 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)
-
-## What does this do?
-
-This allows the user to play the soundtrack of mods outside the main story, sideload music to play alongside it or for mod authors to automatically add their songs in a custom music room.
-
-## What does this version improve on?
+<u>Screenshots:</u> [Compact Mode (Default)](.github/assets/screenshot0001.png) • [List Mode](.github/assets/screenshot0002.png)
+> All songs featured above are owned by the developer and are not included in DDLC OST Player. (Shoo UMG, SME, Rooster Teeth)
 
+## Features
 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!
-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! (Ren'Py 7 Required)
-
-## What do I need to run this?
-
-> This assumes you already have a copy of DDLC with the mod template installed over it.
-
-1. The Latest DDLC OST-Player [ZIP File](https://github.com/GanstaKingofSA/DDLC-OSTPlayer/releases/latest)
-   > If you already have Nikso's Audio Player installed in your mod and are upgrading to this one, copy the ZIP contents to your mod's game folder **and** delete the `audio_player.rpy` file from within within `mod_assets`.
-2. **(Recommended but Optional)** Riffic-Bold from [Fontspring](https://www.fontspring.com/fonts/inky-type/riffic/riffic-bold) to add more font characters to the program.
-   > This font is free, but requires you to make a Fontspring account and have a _Desktop license_ for it in order for you to use this.
-
-## How do I install this?
+5. RPA/APK playback and metadata support!
+6. Improved fonts for foreign languages*.
+   > \* - 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 Recommended)
 
+## Install Steps
 > This assumes you already have a copy of DDLC with the mod template installed over it.
+- For Ren'Py 6, refer to the [Ren'Py 6 installation file](README_Ren'Py6.txt).
+- For Ren'Py 7, refer to the [Ren'Py 7 installation file](README_Ren'Py7.txt).
 
-1. Drop all the contents in this ZIP file into the game folder of DDLC.
-   > 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`
-   ```py
-   build.classify("game/python-packages/**", "mod all")
-   ```
-3. Copy this line to _screens.rpy_ under `textbutton _("Load Game")` and restart DDLC.
-   ```py
-   textbutton _("Music Room") action [ShowMenu("music_player"), Function(ost_start), Stop('music', fadeout=2.0)]
-   ```
-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!
+## FAQ
+- Q. Can I still define songs the old way?
 
-## Can I still define songs the old way?
+   A. Yes you can with some caviats.
 
-Yes you can. The old format still works however you must add this line after defining it.
+   1. `priority` has been removed.
+   2. Manually defined songs require the following to be added after you fill out it's details.
+      ```py
+      ost_song_assign.manualList.append(Wake_Up_Unchanged)
+      ```
+      > Change `Wake_Up_Unchanged` to your song variable.
+      > Using `manualDefineList.append` still works, however it is recommended to use the above over it.
 
-```py
-manualDefineList.append(Wake_Up_Unchanged)
-```
+   See _manualtracks.rpy_ for a example or _audio_code.rpy_ for what can be defined.
 
-> Change `Wake_Up_Unchanged` to your song variable
+- Q. Why is `Riffic-Bold` not included in DDLC OST Player?
 
-Additionally you may use `unlocked` to lock some songs from playing until the player hears it in-game. See _manualtracks.rpy_ for a example.
+   A. Riffic-Bold is not included in DDLC OST-Player due to licensing issues with Fontspring. In order to install Riffic-Bold you will need to download it yourself as a _Desktop license_ and add it to your project. See **Install Steps** on how to do so for your Ren'Py version.
 
-> It is now recommended to move all the manual defines to _manualtracks.rpy_ for easier define access versus doing so in _audio_player.rpy_.
+- Q. How do I add metadata info?
 
-## How do I priortize a song or make a song the first one?
+  A. Right-click your song, Select Properties -> Details, and fill the blank boxes you can. Alternatively, use [MusicBee](https://www.getmusicbee.com/) or a similar music player, or [MusicBrainz Picard](https://picard.musicbrainz.org/) and find your song.
 
-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 > ..._
+  - 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 is `Riffic-Bold` not included in DDLC OST-Player?
+- Q. Why is Ren'Py 7 Recommended for Android?
 
-Riffic-Bold is not included in DDLC OST-Player due to licensing issues with Fontspring. In order to install Riffic-Bold you will need to download it yourself as a _Desktop license_ and install it onto your project as listed above in **How do I install this?**
+  A. Ren'Py 6 has funky code in Android and requires patches to work properly.</u>
 
-## How do I add metadata info?
+- Q. Why did you do this?
 
-Right-click your song, Select Properties -> Details, and fill the blank boxes you can.
-Alternatively, use [MusicBee](https://www.getmusicbee.com/) or a similar music player, or [MusicBrainz Picard](https://picard.musicbrainz.org/) and find your song.
+  A. Cause I was bored and wanted to see RWBY songs play within DDLC and see song covers displayed. (Yang _: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>
+## Credits
 
-## Why did you do this?
+- 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, Ren'Py `loader.py`/`main.py` Code and Feedback
+- Tom Wallroth - Tinytag Code
+- RyzekNoavek#0624 - Adjustable Play Bar Code
+- 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)
 
-Cause I was bored and wanted to see RWBY songs play within DDLC and see song covers displayed. (Yang _:P_)
+Copyright 2020-2022 Azariel Del Carmen (GanstaKingofSA). All rights reserved.

README_Ren'Py6.txt

@@ -0,0 +1,35 @@
+
+Installation:
+
+This assumes you already have a copy of DDLC with the mod template installed over it.
+
+1. Copy the 'game' and 'renpy' folder to your DDLC directory folder (where DDLC.exe/DDLC.sh reside in).
+  a. 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. Copy this line to 'screens.rpy' under textbutton _("Load Game").
+
+    textbutton _("OST Player") action [ShowMenu("new_music_room"), Function(ost_main.ost_start), SensitiveIf(renpy.get_screen("new_music_room") == None)]
+
+3. (Recommended but Optional) Download the Riffic-Bold font from Fontsize here: https://www.fontspring.com/fonts/inky-type/riffic/riffic-bold
+    a. Copy 'riffic-bold.ttf' in the Fonts folder and paste it in 'mod_assets/music_player'.
+    b. Open 'audio_player.rpy' and remove the # symbol in front of line 556.
+
+4. Add music to the track folder or define them manually in 'manualtracks.rpy'.
+5. Run DDLC and enjoy!
+
+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, R7 Loader/Main Code and feedback
+- Tom Wallroth - Tinytag 1.5
+- RyzekNoavek#0624 - Adjustable Play Bar Code
+- 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/Regular Font 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)

README_Ren'Py7.txt

@@ -0,0 +1,36 @@
+
+Installation:
+
+This assumes you already have a copy of DDLC with the mod template installed over it.
+
+1. Copy the 'game' folder to your DDLC directory folder (where DDLC.exe/DDLC.sh reside in).
+  a. DO NOT COPY the 'renpy' folder as this is for Ren'Py 6 ONLY.
+  b. 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. Copy this line to 'screens.rpy' under textbutton _("Load Game").
+
+    textbutton _("OST Player") action [ShowMenu("new_music_room"), Function(ost_main.ost_start), SensitiveIf(renpy.get_screen("new_music_room") == None)]
+
+3. (Recommended but Optional) Download the Riffic-Bold font from Fontsize here: https://www.fontspring.com/fonts/inky-type/riffic/riffic-bold
+    a. Copy 'riffic-bold.ttf' in the Fonts folder and paste it in 'mod_assets/music_player'.
+    b. Open 'audio_player.rpy' and remove the # symbol in front of line 556.
+
+4. Add music to the track folder or define them manually in 'manualtracks.rpy'.
+5. Run DDLC and enjoy!
+
+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, R7 Loader/Main Code and feedback
+- Tom Wallroth - Tinytag 1.5
+- RyzekNoavek#0624 - Adjustable Play Bar Code
+- 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/Regular Font 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)