JotunnLib

Jötunn (/ˈjɔːtʊn/, "giant") Lib is a modding library for Valheim, with the goal of making the lives of mod developers easier.
Get the mod on NexusMods!

⚠️ Merger in progress ⚠️

We're currently working with a few other developers and are in the process of merging JotunnLib and ValheimLib to create a brand new library. You can view our progress here.

In the meantime, JotunnLib will no longer be under active development. However, we will still fix any remaining compatibility issues or breaking bugs.

With this merger, we're hoping to unify the Valheim modding community, and provide one central library for everyone to use. Due to this, we will be focusing on making the new merged library more powerful, easy to use, and well documented than both ValheimLib and JotunnLib ever were. We will take all feature requests and issues raised on this repo into consideration for the new merged library. For any new feature requests, feel free to raise issues on the new repository here.

Additionally, we have plans to make extensive documentation to allow current JotunnLib mods to switch to the new library with minimal effort as soon as it is ready :)

Installation

Instructions for installing and using JotunnLib as a user:

1. You will first need to download BepInEx for Valheim.
   Move the contents of BepInExPack_Valheim folder into <Steam Location>\steamapps\common\Valheim.
   Note: If you already have used any other mods, you likely already have this installed.
2. Download JotunnLib from the Releases page. Unzip the downloaded files into <Steam Location>\steamapps\common\Valheim\BepInEx\plugins.
3. That's it! Now download some mods which use JotunnLib! :)

Features & Roadmap

Currently, JotunnLib lets you create & add all of the following custom things into Valheim:

• [x] Custom prefabs
• [x] Custom inventory items
• [x] Custom recipes
  • [ ] Create using JSON
• [x] Custom input buttons
  • [ ] Ability to change custom keybinds in-game via settings menu
• [x] Custom skills
  • [ ] Add using JSON
• [x] Custom localizations for current language
  • [ ] Localizations for other languages
  • [ ] Localizations from JSON file
• [x] Custom piece tables (create your own variant of the Hammer, Cultivator, etc.)
  • [ ] Create using JSON
• [x] Custom pieces to existing piece tables (adding extra items to Hammer, Cultivator, etc.)
  • [ ] Add using JSON
• [x] Custom vegetation spawning in the world
• [x] Utils for loading custom assets at runtime
  • [x] Loading 2D textures
  • [x] Loading meshes from .obj model files
• [ ] Custom commands
  • [x] Custom console commands
  • [ ] Custom chat commands
• [ ] Listening to game events
  • [x] (Currently very few event listeners implemented)
  • [ ] All game events
• [ ] Custom tabs for in-game settings menu

Developing mods

Visit our documentation site for more info.

Repo structure

The repository is split up into a few parts:

• Code relating to JotunnLib is in the JotunnLib folder
• Documentation source for JotunnLib is within the JotunnLib/Documentation folder
• Demo mod used as an example is in the TestMod folder

Issues

Have any issues or feature requests? Open a pull request or submit an issue!

Contributing

For information about contributing to the repo, see the Contributing instructions.