MusicMod
MusicMod is a base mod that you can depend on to add custom music to your own mod.
About this mod Author’s original text
MusicMod - A Valheim Mod by Joey Parrish
Source:
About
MusicMod is a base mod that you can depend on to add custom music to your own
mod.
Installation
MusicMod is only useful as a dependency for other mods. Mod developers should
install it, build against it, and depend on it. End users will only ever
install it to satisfy dependencies for other mods.
MusicMod is published on both and. Install using your
favorite mod manager.
Sample Usage
using System.IO;
using System.Reflection;
using MusicMod;
public class MyMod: BaseUnityPlugin {
private void Awake() {
// When your mod wakes up, build an absolute path
// to your music file, then tell MusicMod about it.
string assemblyFolder = Path.GetDirectoryName(
Assembly.GetExecutingAssembly().Location);
string absolutePath = Path.Combine(
assemblyFolder, "Main-Menu.mp3");
MusicMod.Mod.OverrideMusic["menu"] = absolutePath;
}
}
Override Keys
Each piece of music in Valheim is identified by a string "key". MusicMod will
discover all music at runtime and print debug logs showing all music currently
in the game. For an up-to-date list, check the log.
These are the current keys showing up in the log as of August 2022:
- respawn
- intro
- menu
- combat
- CombatEventL1
- CombatEventL2
- CombatEventL3
- CombatEventL4
- boss_eikthyr
- boss_gdking
- boss_bonemass
- boss_moder
- boss_goblinking
- morning
- evening
- sailing
- blackforest
- meadows
- swamp
- mountain
- plains
- forestcrypt
- frostcaves
- home
- location_forest
Dependencies
Just BepInEx.
Incompatibilities
None that we know of!
Links
-:
-:
Credits
MusicMod was created by Joey Parrish, and
spun out of Pokéheim.
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file. In multiplayer, the host and every client need the same mods installed.
Install these first, or the mod will not work: