Viking Codex

Stable full release · JustQOL Viking Series

Discover more. Explore together. Viking Codex brings your discoveries, crafting knowledge and biome checklists into one native Valheim interface. Browse what you know, follow clues toward what you have yet to find, and share supported item discoveries with other Vikings on your server.

Features

Your own Viking encyclopedia

• Browse base-game items, creatures, crafting recipes, building pieces and crafting stations.
• Filter by biome, category and discovery status. Sort by progression or alphabetically.
• Search discovered content and discovery clues without exposing hidden names.
• View an item and its related recipes together without duplicate recipe rows.
• See newly discovered entries marked NEW until you view them during that session.

Clues without spoilers

Undiscovered entries display a clue instead of revealing their identity. A clue might point you toward red fruit growing on low bushes, while the item's name and recipe details stay hidden. Unknown icons appear as silhouettes where an icon is available. Select an entry to read its full clue, or search the clue to narrow your next destination.

Biome discovery checklists

Each biome shows its discovered count, completion percentage and discoveries remaining. Search and category filters do not shrink that biome's completion total. Discovered entries appear first in the All view, and Unclassified entries have a separate filter.

Completion refers to the entries assigned to that biome in the current catalog. It does not represent every possible activity or discovery in Valheim. Unclassified entries remain available in the All view.

Crafting information at a glance

Review descriptions, known ingredients, crafting stations, station levels and related recipes. The Codex distinguishes discovered, recipe known and currently craftable states. Missing resources and station requirements are highlighted; unknown ingredients and undiscovered recipe details stay hidden.

Optional Wiki buttons open mapped pages for discovered entries when you choose to use them. Viking Codex makes no background Wiki requests.

Discover together

Supported base-game collectible-item encounters contribute to the server's shared discovery history, including supported food and equipment. Other connected characters receive that knowledge through Valheim's native item-registration and recipe-unlock logic.

• Sharing applies across the server, rather than only to nearby players.
• An item encounter can contribute even when the collecting character already knows the item.
• Joining or reconnecting characters receive eligible knowledge already recorded by that server, with offline catch-up enabled by default.
• Joining a server does not upload a character's entire previous knowledge. Contributions come from supported encounters during play.
• Learned knowledge belongs to the character; shared history is stored separately for each world.
• Creature encounters and crafting-station knowledge are not shared.

Sharing grants knowledge, not physical items. Resources, crafting stations, station levels and other crafting restrictions still apply.

How to use

Control	Action
Viking Codex main-menu button	Open the controls and discovery guide
F8 in a world	Open or close the Codex
Codex inventory button	Open the Codex from your inventory
Up / Down outside text fields and dropdowns	Move between entries
Escape or Close	Close the Codex and return to the game

Choose a biome, category and discovery filter, then select an entry to inspect it. Clear filters resets the view. The main-menu guide is available before entering a world; your character's catalog is browsed in a loaded world.

The interface uses Valheim wood panels, Averia Serif text, warm highlights and native controls to match the JustQOL Viking Series.

Installation and updating

Required dependencies:

• BepInExPack Valheim 5.4.2351
• Jotunn 2.30.2 or a newer compatible version

Mod manager: install VikingCodex by JustQOL through Thunderstore Mod Manager or r2modman. The manager installs declared dependencies automatically. Close the game or server before updating, then restart after installation.

Manual: install the dependencies, then place the VikingCodex plugin folder under BepInEx/plugins/. Keep only one installed copy of VikingCodex.dll. Preserve configuration, character/world saves and the mod's world-history files when updating.

Multiplayer

Install matching Viking Codex gameplay versions and the dependencies on the server and every client, including when sharing is disabled. Restart the server and all clients after an update.

Server settings control discovery sharing and catch-up. Local interface settings control your own Codex presentation. Disabling the interface does not require disabling sharing, and disabling sharing does not require disabling the interface.

Previously recorded server history is retained. Knowledge imported by older releases is not automatically removed from characters or history.

Configuration

First launch creates BepInEx/config/com.vikingcodex.cfg.

Setting	Default	Purpose
EnableCodex	true	Enable the local Codex interface
CodexShortcut	F8	Choose the keyboard shortcut
ShowInventoryButton	true	Show the inventory entry button
InventoryButtonOffset	(-100, 35)	Reposition the button around other UI mods
HideUndiscoveredNames	true	Keep unknown identities and recipe details hidden
ShowUnknownPlaceholders	true	Show undiscovered entries as clue slots
EnableWikiLinks	true	Offer intentional Wiki links for known entries
EnableSharedDiscovery	true	Enable server-wide discovery sharing
ShareEligibleMaterials	true	Enable supported item-knowledge contributions
OfflineCatchUp	true	Deliver recorded history to joining characters
EnableDebugLogging	false	Enable additional diagnostic logs

The legacy ImportExistingDiscoveries and EnableModdedContentDetection settings are ignored. They cannot enable bulk character-knowledge import or add modded identities to the catalog.

Advanced users can customize presentation metadata under BepInEx/config/VikingCodex/metadata/: biome assignments, ordering, descriptions, discovery clues and mapped Wiki pages for existing base-game identities. Metadata does not grant items, bypass progression or add non-base-game identities. See docs/CONFIGURATION.md for the file format and merge rules.

With Valheim's console enabled, vikingcodex status shows registry and sharing status, vikingcodex reload reloads local metadata, and vikingcodex export confirm writes a diagnostic catalog export. The export intentionally contains spoilers. Console commands are optional.

Restart the server and reconnect clients after changing server policy.

Compatibility

Built for Valheim 1.0.20. The catalog and sharing registry are base-game only. Modded items do not contribute to this checklist or shared discovery registry, even when a legacy configuration says otherwise.

Other mods may add crafting restrictions that the Codex does not display. Actual crafting remains controlled by the game and installed mods. If an inventory UI mod overlaps the Codex button, adjust its offset or disable the button and use F8.

Catalog and biome assignments can contain Unclassified entries. Report incorrect mappings through the community channels so they can be corrected.

Community and support

Join JustQOL | Valheim Mods on Discord for support, announcements, bug reports and suggestions.

For Viking Codex help, use viking-codex-support. Report reproducible issues in bug-reports. Include your mod and Valheim versions, server/client setup, other installed mods, reproduction steps and relevant BepInEx errors with private information removed. You can also message goon4207 on Discord.

Powered by Astra

Created with assistance from OpenAI Codex, under the project owner's direction.