Jotunn

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.

This project was originally derived from the base structure of JötunnLib, and had many entity abstractions and features from ValheimLib merged into it before we proceeded with further implementations. We have lots of features planned for the future, and we hope the community has many feature requests to suggest. I hope the features we have implemented thus far prove to be a useful base and provide an idea of the consistency we aim to deliver moving forwards.

Usage

Please refer to our documentation. We have gone to great lengths to ensure there is ample documentation to facilitate the developer's 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:\\steamapps\common\Valheim).

• Install Jötunn:\

Download from either, 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, Smelter and Incinerator 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.
• CustomPieceTable - Represent ingame building tables. Support for custom categories included.
• CustomRecipe - Represents ingame recipes for managing crafting and upgrading of items.
• CustomStatusEffect - Represents ingame status effects from weapon hit effects to guardian powers.
• CustomVegetation - Represents vegetation spread throughout biomes from pickables to cosmetics.
• KitbashObject - Represents a custom object assembled from various other prefabs' components.
• Mocks - Fake any vanilla prefab and use it in your custom assets - Jötunn resolves the references to the vanilla objects at runtime.
• Config classes - There are many more abstractions beside the main entities which allow for easy creation of things like key bindings, custom commands, skills and more.

Managers

• Command Manager - Facilitates implementation of methods which can be registered as executable console commands.
• CreatureManager - Add new creatures or copy and modify vanilla ones.
• GUI Manager - Allows invocation of UI prefabs on the fly via code.
• Input Manager - Provides an interface for binding keys via ZInput in a consistent manner, facilitating custom keybind hints.
• Item Manager - Abstracts away implementation details of configurations applied to items/recipes to provide a consistent developer experience in adding new items. tl;dr items are easy!
• Kitbash Manager - Create custom assets with individual pieces