About this mod
Add tracks to Music Type lists and Music Type lists to Locations or Regions at runtime à la SPID
- Requirements
- Permissions and credits
- Changelogs
Add tracks to Music Type lists and Music Type lists to Locations or Regions at runtime à la SPID. Uses distributions defined in _MUS.ini files found in the root folders of mods, similar to other distributors.
Usage
_MUS.ini files consist of key-value pairs where the key is the EditorID of the Music Type to distribute to, the EditorID of the Location to distribute to, or the EditorID of the Region to distribute to, and the value is a Distribution String (<DISTR>) or Music Type list (<MUSICTYPE>).
Syntax for distributing tracks to Music Type lists:
- <DISTR> := <identifier>[,<identifier>,...]
- Values consist of one or more <identifier>s separated by commas
- Values consist of one or more <identifier>s separated by commas
- <identifier> := FormID~PluginName
- Example: 0x3301~Skyrim.esm
- Example: 0x3301~Skyrim.esm
- <MUSICTYPE> := <EditorID of Music Type>[!]
- Adding an optional exclamation point to the EditorID of the Music Type clears the tracklist before adding the tracks defined on the right hand side of the equals sign.
- If no existing Music Type with the given EditorID is found, a new Music Type with that EditorID will be created dynamically.
- Example: MUSCombat! = 0xbcf52~Skyrim.esm clears the MUSCombat list and adds the given track
- Example: MUSCombat = 0xbcf52~Skyrim.esm adds the given track to MUSCombat without clearing the tracklist
- Example: MySuperCoolMusicType = 0xbcf52~Skyrim.esm adds the given track to a new tracklist called MySuperCoolMusicType
Syntax for distributing Music Type lists to Locations:
- <LOCATION> := <EditorID of Location>
- <MUSICTYPE> := <EditorID of Music Type>
Syntax for distributing Music Type lists to Regions:
- <REGION> := <EditorID of Region>
- <MUSICTYPE> := <EditorID of Music Type>
INI Syntax:
- [General] section (for distributing tracks to Music Type lists):
- <MUSICTYPE> = <DISTR>
- <MUSICTYPE> = <DISTR>
- [Location] section (for distributing Music Type lists to Locations):
- <LOCATION> = <MUSICTYPE>
- <LOCATION> = <MUSICTYPE>
- [Region] section (for distributing Music Type lists to Regions):
- <REGION> = <MUSICTYPE>
- <REGION> = <MUSICTYPE>
NOTE: _MUS.ini files are processed in alphabetical order, and uppercase letters are sorted before lowercase letters (i.e., A_MUS.ini will be processed before a_MUS.ini).
The following settings, found in MusicTypeDistributor.ini, can be used to toggle some helpful functionality for writing _MUS.ini files:
- bDumpMusicTracks: If set to true, dump all music tracks to MusicTypeDistributor.log
- bDumpMusicTypes: If set to true, dump all Music Types to MusicTypeDistributor.log
- bDumpLocations: If set to true, dump all Locations to MusicTypeDistributor.log
- bDumpRegions: If set to true, dump all Regions to MusicTypeDistributor.log
Source code: GitHub
Built with CommonLibSSE-NG. Should work for all versions of Skyrim (SE, AE, and VR).
Compatibility
- Compatible with everything
- Always safe to install/update/uninstall
Check out my other mods
Credits
- powerofthree for powerofthree
- CharmedBaryon, fudgyduff, and everyone involved in Skyrim reverse engineering
- colinswrath for fielding my dumbass questions about SKSE development
- Skyrim RE Discord server for helping with all sorts of stuff