jvdbout / valheimlib

A library to facilitate valheim modding

Merging in progresss : checkout https://github.com/Valheim-Modding/Jotunn

ValheimLib - A library to facilitate valheim modding

About

ValheimLib is a modding framework for other mods to work in, providing centralized and simplified APIs for Valheim.

This helps keeping mods compatible with each other.

At it's core, ValheimLib should not change how the game behaves without any other mod installed.

Installation

The contents of ValheimLib should be extracted into the BepInEx folder, such that the ValheimLib folder in plugins in the archive is inside your plugins folder of your BepInEx installation.

Make sure that you have also installed the HookGenPatcher. This tool generates the MMHOOK files that ValheimLib needs to function properly.

Developing

For mod developers that wish to use ValheimLib on their plugin.

• Download this release, make sure to follow the installation instructions above, and add the ValheimLib.dll as an assembly reference in your visual studio project.

• Add the BepInDependency attribute top of your class that is heriting from BaseUnityPlugin, like so :

[BepInDependency(ValheimLib.ValheimLib.ModGuid)]

We also have an ExampleMod visual studio project that showcase some features of ValheimLib.

Documentation will be included in the xmldocs, and further information may be on the dedicated ValheimModding wiki. Do not hesitate to ask in the modding discord too!

Changelog

0.0.16

• Add BoneReorder, can be activated by doing BoneReorder.ApplyOnEquipmentChanged(). It'll correct any bone disorder caused by unity incorrectly importing ripped assets when doing custom equipments for example.

0.0.15

• AddToken was adding to French language by default instead of English, oops.
• Add support for json language files, folder hierarchy is strict because of Crowdin format : Json files goes into : BepinEx/plugins/[OptionalAmountOfFolders]/Translations/[English/French...etc]/[AnyName].json

0.0.14

• Add multiple languages support for the Language helper class. Add Language.AddPath(pathToLanguageFile) method.
• Any .language file present in the bepinex plugins folder will be added to the game localization
• Add an event called ObjectDBHelper.OnBeforeCustomItemsAdded that fires before any custom items / recipes / status effects are added, it will allow you to clone an existing one from code, modify it, and register it using ObjectDBHelper.Add

0.0.13

• Fix custom pieces getting destroyed from the scene.

0.0.12

• Custom prefabs now shouldn't be removed on subsequent world loads.
• Added some documentations for mod devs.
• New recipes are unlocked (if unlockable) at game start and need no inventory update.

0.0.11

• Fix nullref for SafeInvoke

0.0.9

• Helper for adding new mobs to spawning system
• Fix nullref for ghost placements.

0.0.8

• Update README to notify about the HookGenPatcher dependency.
• Fix error when creating new character.

0.0.7

• FixReferences now handle enumerable of objects

0.0.6

• Mock use generic to support all Component
• InstantiateClone now register to znetscene if needed and tries to makes clone name unique
• Fix the SetupVisEquipment exception in the main menu

0.0.5

• Add Mock for CraftingStation. Better error handling for ItemDrop.IsValid

0.0.4

• Custom item data save system : Serialization to a file in case the user play the game without having custom items installed and don't want to see them gone when installing the mods back.

0.0.3

• Forgot to add the mmhook package dependency. Oops.

0.0.2

• Mock system for retrieving correct UnityObject instances at runtime.

0.0.1

• Helper for Prefab cloning
• Helper for custom item and recipes addition.