You are viewing a potentially older version of this package. View all versions.
JotunnLibTeam-JotunnLib-0.1.6 icon

JotunnLib

JotunnLib is a modding library for Valheim, with the goal of making the lives of mod developers easier. It's a centralized API to allow mod developers to easily add custom items, recipes, prefabs, and more to the game, working for both servers and clients.

Date uploaded 2 months ago
Version 0.1.6
Download link JotunnLibTeam-JotunnLib-0.1.6.zip
Downloads 9833
Dependency string JotunnLibTeam-JotunnLib-0.1.6

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.800 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.800

README

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!

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.