Skip to content

Commit

Permalink
new ZIP layout
Browse files Browse the repository at this point in the history
  • Loading branch information
Bronya-Rand committed Jan 30, 2022
1 parent 3185ad4 commit c55859f
Show file tree
Hide file tree
Showing 45 changed files with 1,431 additions and 34 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
DDLC-OSTPlayer-*.zip
mod_assets/music_player/riffic-bold.ttf
riffic-bold.ttf
new_audio_player.rpy
51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,50 +27,43 @@ This allows the user to play the mods' soundtrack alongside a players' own music
> \* - 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)

## Installation Requirements
## Install Steps
> 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).
2. **(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.
- 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).

## FAQ
- Q. Can I still define songs the old way?

A. Yes you can with some caviats.

## Install Steps
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. Copy this line to _screens.rpy_ under `textbutton _("Load Game")`.
```py
textbutton _("OST Player") action [ShowMenu("new_music_room"), Function(ost_start), SensitiveIf(renpy.get_screen("new_music_room") == None)]
```
3. **(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 line `556`.
4. Put music in the `track` folder inside the `game` folder and try it out!

## Can I still define songs the old way?
Yes you can with some caviats.
1. `priority` has been removed.
2. Manually defined songs require the following to be added after you fill out it's details.
```py
manualDefineList.append(Wake_Up_Unchanged)
```
> Change `Wake_Up_Unchanged` to your song variable

See _manualtracks.rpy_ for a example or _audio_code.rpy_ for what can be defined.
See _manualtracks.rpy_ for a example or _audio_code.rpy_ for what can be defined.

- Q. Why is `Riffic-Bold` not included in DDLC OST Player?

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.

- Q. How do I add metadata info?

## Why is `Riffic-Bold` not included in DDLC OST Player?
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. 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.

## How do I add metadata info?
- 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_.

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.
- Q. Why is Ren'Py 7 Recommended for Android?

- 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_.
A. Ren'Py 6 has funky code in Android and requires patches to work properly.</u>

## Why is Ren'Py 7 Recommended for Android?
Ren'Py 6 has funky code in Android and requires patches to work properly.</u>
- Q. Why did you do this?

## 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_)
A. Cause I was bored and wanted to see RWBY songs play within DDLC and see song covers displayed. (Yang _:P_)

## Credits

Expand Down
6 changes: 2 additions & 4 deletions install.txt → README_Ren'Py6.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Installation:

This assumes you already have a copy of DDLC with the mod template installed over it.

1. Copy the ZIP files to your DDLC game folder.
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.

Expand All @@ -12,14 +12,12 @@ This assumes you already have a copy of DDLC with the mod template installed ove
textbutton _("OST Player") action [ShowMenu("new_music_room"), Function(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 the game/mod_assets/music_player folder
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!

Read README.md on Github or here for more information.

Credits!
- Nikso - Original Developer
- Sam Kujo#9403 - Original Design and Beta Tester
Expand Down
36 changes: 36 additions & 0 deletions README_Ren'Py7.txt
Original file line number Diff line number Diff line change
@@ -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_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)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit c55859f

Please sign in to comment.