[1.0, B18, A17] Custom Music (1.3) Listen to whatever you want

[Chais]

Custom Music

Description:
As great as RimWorld's music is, sometimes it's time for a change. With this mod you can listen to your local music library in RimWorld. Just point it to a directory and it will add the songs to the game's track list.

Features

• File Explorer (Open): Conveniently navigate to the directory with your music. Click OK to use the current directory, or Cancel to keep using the previous one.
• Click Update to rescan the directory. This adds new configs for new songs, removes configs for songs no longer present and keeps the rest.
• The music directory can contain subdirectories that will be searched for files, as well.
• Quick access to volume and "battle music" flag
• Configure all settings in the advanced settings (gear column)

Author/Mod Team
Me with help of erdelf, Brrainz, KeenKrozzy, WhyIsThat and #rimworld-modding on Discord as well as ison.

Download
Attachment
https://steamcommunity.com/sharedfiles/filedetails/?id=1091642181
https://gitlab.com/Chais/CustomMusic-Rimworld/tags

Getting OGG files

• Download fre:ac, a free, open source audio converter. The zip doesn't require installation. Packages for OSX and Linux are offered, too.
• Unpack/install to a directory of your choice
• Start the program (freac.exe on Windows, freac on Linux, freac application on macOS
• Add all the files you want to convert to the Joblist (you can add single files as well as directories)
• In Options > General settings... set the Filename pattern to something something simple as "<title>" or "<artist> - <title>". Check "Append sequential numbers..."
• Optionally: Options > Configure selected encoder... Choose an encoding mode. VBR is fine if you don't know the difference. Choose a quality. Higher value means better quality but larger file. Keep in mind that qualty can't actually be increased when converting from mp3 or other lossy formats, but the file will still be larger. 6 should be a good value for most cases.
• Set the output folder to the directory you want RimWorld to play music from
• Start the conversion (circular play button)

Words of caution
RimWorld's ogg player is very sensitive to "irregularities". Should you already have OGG files or have acquired them from another program, make sure they don't contain a video track. Some encoders put the cover art in a video track, instead of the ID3 tags. RimWorld will not only not play these files, but they can even prevent valid songs from loading properly. So if you have trouble with your songs playing, perhaps try adding them one by one to see which one breaks the chain.

How to install:
- Unzip the contents and place them in your RimWorld/Mods folder.
- Activate the mod in the mod menu in the game.

[attachment deleted by admin: too old]

[Apposl]

Thank you, I'm going to try this out with some audio downloaded from TabletopAudio (not affiliated, highly recommend).

[Chais]

Non-destructive updates and support for recursion

Updating the song list no longer deletes the list of know songs, erasing
their configurations, but keeps configs that already exist, adds new ones
for new songs and only removes the configs of songs that are no longer
present in the music directory.
Also the music directory is now searched recursively.

Updated archive in OP.

[Chais]

Fixed an issue where songs only played once. Updated archive in OP.

[SpaceDorf]

Nice One .. to bad I watch so much TV instead of listening to music.

[Chais]

Streaming is now working flawlessly, thanks to Harmony. This means the lowest possible memory footprint, no lag-spikes when songs load and songs can be played as often as wished.

[Chais]

Updated for A18.

[BTAxis]

I've noticed that the tracks I've flagged for combat use aren't actually played during combat (or indeed ever). Not sure if that's because of the mod or because of a bug in B18.

[kixiye]

Hello!
I have enjoyed using your mod for some time now, and today I went to the mod settings menu to adjust some of the tracks I have listed, and I was met by an error message. I have added many mods after it, and I don't think there is an error with your mod itself but I wonder if you have any tips about what may cause this and how I can fix it?
many thanks.
The error is as follows
[HugsLib][ERR] Exception during DoWindowContents: System.ArgumentException: Illegal characters in path.
  at System.IO.Path.GetFileName (System.String path) [0x00000] in <filename unknown>:0
  at System.IO.Path.GetFileNameWithoutExtension (System.String path) [0x00000] in <filename unknown>:0
  at CustomMusic.MusicMod.DoSettingsWindowContents (Rect inRect) [0x00000] in <filename unknown>:0
  at RimWorld.Dialog_VanillaModSettings.DoWindowContents (Rect inRect) [0x00000] in <filename unknown>:0
Verse.Log:Error(String)
HugsLib.Utils.ModLogger:ReportException(Exception, String, Boolean, String)
RimWorld.Dialog_VanillaModSettings:DoWindowContents(Rect)
Verse.<WindowOnGUI>c__AnonStorey0:<>m__0(Int32)
UnityEngine.GUI:CallWindowDelegate(WindowFunction, Int32, Int32, GUISkin, Int32, Single, Single, GUIStyle)

EDIT -----
I managed to solve it by deleting the settings folder and reinstalling the mod.

[Chais]

Update for RimWorld 1.0. I'm not dead, folks 

[cosmic alpaca]

Does anyone have a playlist to share? bonus points for direct download