RimWorld

RimWorld

256 ratings
Custom Music
2
2
2
   
Award
Favorite
Favorited
Unfavorite
Mod, 1.2, 1.3, 1.4, 1.5
File Size
Posted
Updated
124.971 KB
27 Jul, 2017 @ 3:57am
25 Apr, 2024 @ 6:07am
20 Change Notes ( view )

Subscribe to download
Custom Music

Description
Looking for co-maintainers
I haven't actively played the game in months, which leads to me frequently missing updates. I don't want the mod to fall into disrepair so I'm looking for someone to help keep the mod up-to-date with the game. Feel free to contact me if you're interested.

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.
For clarity, as it seems to be unclear: this mod is not a simple media player in RimWorld. It is a loader for external music files to be played according to the same rules as vanilla music or the songs of any music pack mod, like p-music.
Your music will be played as situational as you configure it to be. Want to fight off raiders while listening to DragonForce? You can! Want to meet fall with some classical piano music? Go right ahead.

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.
  • The music directory can have subdirectories that will be searched for files, too.
  • Click Update to rescan the directory. Adds new songs, removes configs for removed songs and keeps the rest.
  • Quick access to volume and "battle music" flag
  • Configure all settings in the advanced settings (gear column)

Getting OGG files
In case you don't know how to convert your music to ogg, here is a simple guide.
  1. Download fre:ac[www.freac.org], a free, open source audio converter. The zip doesn't require installation. Packages for OSX and Linux are offered, too.
  2. Unpack/install to a directory of your choice
  3. Start the program (freac.exe on Windows, freac on Linux, freac application on macOS
  4. Add all the files you want to convert to the Joblist (you can add single files as well as directories)
  5. In Options > General settings… set the Filename pattern to something something simple as "<title>" or "<artist> - <title>". Check "Append sequential numbers…"
  6. 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.
  7. Set the output folder to the directory you want RimWorld to play music from
  8. 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.

Related Mods
Disable Vanilla Music

Legacy version
Custom Music (B19)
Custom Music (B18)
Custom Music (A17)

Acknowledgements
My thanks go to erdelf, who put me on the right track on where to hook into the game, as well as WhyIsThat, KeenKrozzy and Brrainz for helping to optimise the loading procedure.

Thanks to Demrenus for updating the mod for 1.5 as well as the Russian translation.
Popular Discussions View All (3)
60
1 Jul @ 4:33am
PINNED: Bug reports
Chais
280 Comments
llunak 9 Jul @ 11:21pm 
As far as I can judge, the mod works fine in 1,6, after updating About.xml and a rebuild. Note that until 1.6 is the stable version, the default Krafs.Rimworld.Ref version is still 1.5 (so something like https://pastebin.com/nzmyYb2b is needed until the release).
Chais  [author] 9 Jul @ 10:47am 
llunak 9 Jul @ 12:51am 
Do you have a git repository of this somewhere? It's rather strange to ask for help with the mod but not provide a way to do it. If you don't have time, people could submit updates, or somebody like Mlie could pick this up.
fungianura 30 May @ 2:05pm 
i rarely comment on mods, but this is a life changer for my star wars themed playthrought, thanks a lot.
VHS 11 Mar @ 10:49am 
Exactly what i was looking for. Thank you very much
Mattatatta 15 Feb @ 4:10pm 
I see, I figured it was a deliberate choice but wanted to confirm. I couldn't imagine it being 'forgotten' but a browse through the backlog didn't give any clues to me. Asking directly was the simplest path to an answer.
Chais  [author] 15 Feb @ 9:15am 
That has been requested a couple of times and I have stated every time that it won't happen. Simply because it isn't what I want this mod to be. What I always liked about music in Rimworld is that it's situational and doesn't play all the time. But I missed the option to add and configure custom songs. So that is what this mod does and it's all it will ever do.
If you just want random music to play you can use any media player. It doesn't even have to be tied in to the game at all. Get VLC, set up a playlist and set it to shuffle. This way you don't even have to deal with the finicky OGG decoder in Unity.
Mattatatta 14 Feb @ 11:19pm 
I'm not sure if this was ever requested in the past, but a simple "media player" in-game widget would make this mod a godsend. It feels like an odd feature to omit when it's found in other music managers
Chais  [author] 19 Nov, 2024 @ 10:42am 
To my knowledge that isn't something Rimworld offers. I'm not extending the way Rimworld plays music in any way. Just offering a way to configurably inject songs.
Lobanych 18 Nov, 2024 @ 11:20am 
It would be great if combat tracks could be limited to specific factions. For example, I have a great track in mind for combat with mechanoids, but it is ONLY suitable for combat with mechanoids, it does not fit the theme of other factions.