Valheim

File information

Last updated

Original upload

Created by

Valheim Modding

Uploaded by

ValheimModding

Virus scan

Safe to use

About this mod

Jötunn (/ˈjɔːtʊn/, "giant"), the Valheim Library was created with the goal of making the lives of mod developers easier. It enables you to create mods for Valheim using an abstracted API so you can focus on the actual content creation.

Requirements
Permissions and credits
Mirrors
Changelogs
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 put the `Jotunn.dll` file inside the `BepInEx\plugins` folder in 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.
- 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.
- Creature Manager - 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 from vanilla prefabs.
- KeyHint Manager - Create custom key hints for your weapons and tools, even down to the selected piece.
- Localization Manager - Provides multiple methods of loading localisation data into the game, as well as exposing an interface for adding additional languages to provide localizations to unsupported languages.
- Minimap Manager - Alter map data or create overlays for the map.
- Piece Manager - Very similar to the Item Manager, abstracting implementation details of configurations for pieces/recipe's.
- Prefab Manager - Provides a cache of prefabs registered through other managers, mostly developers will only query the cache for prefabs added via other managers.
- Render Manager - Provides a custom render queue to render visual GameObjects into a Sprite - Useful to generate icons for your custom items.
- Skill Manager - Facilitates additional custom skills.
- Zone Manager - Create custom locations and vegetation to add in the world generation.

Utilities
- Asset Helpers - Methods to facilitate referencing and loading of assets.
- Bone Reorderer - Fixes bone ordering issues on [code single]SkinnedMeshRenderer[/code]'s that have been ripped and imported into unity.
- Network Compatibility - Allows plugins to define their own version requirements for clients connected to the server. Ensures a customisable level of interoperability with clients of differing mod configurations on a plugin-by-plugin basis.
- Config Synchronisation - Allows administrators to adjust configuration values via an in game menu. Config setting is synced to connected clients.
- Mod Registry - Query added content per Mod.
- SimpleJSON - We have imported SimpleJSON into our library at the request of developers who would simply prefer to have this dependency taken care of already. We use the MIT Licensed SimpleJSON

Bugs, Support, Contributions
Please refer to our documentation before requesting support via discord. If there are any mod interoperability issues developers experience (not just exclusive JVL issues), we would like to hear from you! If we can facilitate better mod interoperability by providing a common interface, or exposing native valheim objects, including a utility which you have created, then please feel free to create a new feature request or pull request.

Roadmap
Check our projects for a more up to date list of features currently in development, or suggest your own features for inclusion by creating a new feature request

Changelog
See the full Changelog.

Contributors to Jötunn, the Valheim Library
These people have been integral to pushing JVL out of the door, and without them we could not have achieved nearly as much. Please give them some love on github, thunderstore, and nexus.

Core:
- IDeathHD#7866: github, thunderstore
- Algorithman#6741: github
- Jules#7950: github
- Quaesar#5604: github
- radu#0571: github, thunderstore, nexus
- paddy#1337: github, thunderstore, nexus
- Margmas#9562: github, thunderstore, nexus

Contributors:
- Cinnabun#0451: github
- GoldenJude#8965: github, nexus
- zarboz#7828: github, thunderstore, nexus
- MarcoPogo#6095: github, nexus
- blaxxun#9098: github
- Tekla#1012: github
- JoeyParrish#8644: github, thunderstore, nexus
- Nosirrom#2626: github