Jotunn the Valheim Library

Jötunn, the Valheim Library

Jötunn (/ˈjɔːtʊn/, "giant"), the Valheim Library, was created with the intent to facilitate developer creativity, unify the communities problem solving efforts, and enhance developer productivity by curating a library of common helper utilities. Additionally, it supplies specific interfaces and abstractions which aid with mod interoperability, networked gameplay consistency, and remove the need to maintain valheim version specific code by acting as an interface between the developer and the games changing internals.

Jötunn is not JotunnLib is not ValheimLib

Jötunn was created as a joint effort to merge JotunnLib and ValheimLib into a single library to use the best of both worlds. It is possible to use all three libraries side by side so all current mods will continue working. But it is highly recommended to port your mod to this new library as the other two won't be actively developed anymore.

Usage

Please refer to our documentation. We have gone to great lengths to ensure there is ample documentation to facilitate the developers learning experience.

Installation

If you're using a mod installer, you can likely ignore this section.

For a more in-depth installation guide, please check out the manual installation guide in our documentation.

However, here is a quick run-down:

• []Install BepInEx:

  Download BepInEx, extract everything inside BepInEx_Valheim into your Valheim folder (typically C:\<PathToYourSteamLibary>\steamapps\common\Valheim).

  []Install Jötunn:

  Download from either Nexus / Thunderstore, extract the ZIP and place all content into BepInEx/plugins/Jotunn of your Valheim install.

That's it, launch the game and mod away!

Features

JVL provides three distinct groups of features. Entities, which abstract the game's own entities into easy-to-use interfaces. Managers, which act as interfaces between the entities and native collections or subsystems. Utilities, which are there to aid in generic/common functions that can span many different areas.

Entities

- CustomCreature - Represents custom animals, enemies and NPCs.

- CustomItem - Represents ingame items such as weapons, tools and consumables.

- CustomItemConversion - Represents ingame item conversions for the CookingStation, Fermenter and Smelter in one abstraction.

- CustomLocalization - Represents custom localizations for your mod.

- CustomLocation - Represents custom locations from simple stone circles to complete villages.

- CustomPiece - Represent ingame building pieces.

- CustomPieceT