• We have updated our Community Code of Conduct. Please read through the new rules for the forum that are an integral part of Paradox Interactive’s User Agreement.

Runite Drill

aka Utopia
60 Badges
Jan 15, 2016
717
604
utopiamusic.net
  • Cities: Skylines - Natural Disasters
View attachment 876393

Live link: Music Mod Creation Tool
Source code: Github

Music Mod Creation Tool
by Runite Drill / Utopia
The Music Mod Creation Tool (MMCT) is an easy-to-use online tool that generates the code needed to add music to any of the supported games. Using only the mod name and user-supplied .ogg audio files, the tool provides a .zip file containing the relevant folders that the user can copy into their mod. This is all that is required to get the music working in-game and the entire process takes less than half a minute.
The tool can generate files for multiple games at the same time. Currently, the following games are supported:

  • Europa Universalis IV
  • Crusader Kings III
  • Crusader Kings II
  • Hearts of Iron IV
  • Imperator: Rome

How to use this tool​

Creating music mod files with this tool is very easy.

On the form provided, enter name for your mod according to the following rules:

  • Your mod name must be at least 3 characters long, and up to a maximum of 32 characters.
  • Your mod name can only consist of letters, numbers, underscores and hyphens.
Once you have a chosen a name, select at least one game to generate music mod files for. If you select multiple games, files will be generated for all of them. Note that some options are greyed out, either because they are being worked on or are actively planned for the future.

Finally, use the file uploader to upload all the music files you wish to include in your mod. You can upload mulitple files at once. The following rules apply to uploading files:

  • Files must be in .ogg format, as required by Paradox Interactive.
  • You must upload at least one file. The maximum limit is 100.
  • Individual files cannot be larger than 100MB in size.
  • Files must have a unique name from each other.
  • File names cannot include spaces or periods ..
It is also recommended that you format your files with 32 bits, a 44.1kHz frequency and a 192KB/s bit frequency to avoid any distortion or nonfunctionality of your music.

Once you have done this you can generate the code for your music mods!

When the code generation has completed a download should automatically start and a .zip file will appear in your downloads folder. Inside the zip you will find a folder for each game selected and inside the game folders you will find all the folders, code and assets needed to add music to the game. Simply copy all the folders within the game folder to the root folder of your mod and you're done!

Compatibilities​

Currently, this tool works for:
  • Europa Universalis IV
  • Crusader Kings III
  • Crusader Kings II
  • Hearts of Iron IV
  • Imperator: Rome
Support for Stellaris, Cities: Skylines and Victoria 3 is planned.

This tool also has support for replacing the main theme for Europa Universalis IV. To do so, simply name your music file maintheme.ogg. This feature is planned for the other games and as such maintheme.ogg is a reserved file name and will be skipped over by the tool for these games.

Limitations​

This tool generates code based on the inputs you provide it, however, it is limited in its capabilities.

Most importantly, this tool does not generate a whole new mod (e.g. the .mod and descriptor files). It only generates the relevant files needed to implement music within an existing mod. As such you may need to create a new mod to add the generated files into.

This tool is intended to provide you with a simple, working, framework from which you can further customise as you wish. As such, this tool does not generate code that implements modifiers or alters the chances of your music playing in-game. For example, if you wish for your music to only play for a specific country you will have to go into the script and add this yourself. However, to assist with this the code does generate an example of a modifier implementation, but this is commented out of the script.

Additionally, for relevant games (CK3 / I:R) the tool only implements background/mood music and does not implement triggered/event music. This is something that you will also need add yourself.

Finally, for games that implement radio stations (HOI4) the tool provides a default image to use as the radio station cover. The template radio station cover is provided, and you are encouraged to create your own cover to replace the default image.

For more information on music modding, consult the game's respective Paradox Wiki (e.g. the music modding page for EU4).


Contact​

If you have questions or need assistance please check the FAQ on the website. Otherwise, you are welcome to contact me on Discord or leave a message here.

Enjoy!