You are viewing a potentially older version of this package. View all versions.
sighsorry-ReferToCompendium-1.0.0 icon

ReferToCompendium

A persistent raven hint and personal compendium ordering, collapse, and restore. Client only.

Date uploaded 2 weeks ago
Version 1.0.0
Download link sighsorry-ReferToCompendium-1.0.0.zip
Downloads 46
Dependency string sighsorry-ReferToCompendium-1.0.0

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2351 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2351

README

ReferToCompendium

A small client-side Valheim mod that makes the Compendium easier to find and keeps its list in your preferred order.


Many players often doesn't even bother clicking the Compendium button even though some mods would put useful info there.
So this mod gets players attention to the Compendium.

Player can edit the order of Compendium entries. And Some entries can be hidden.

Edited info of Compendium is located in %USERPROFILE%\AppData\LocalLow\IronGate\Valheim\ReferToCompendium\layout-shared.json

Features

  • Raven hint: a short message beside the raven's beak, styled like NPC speech. It stays visible while the inventory is open, without fading, and hides while another panel is in front.
  • Personal order: move Compendium entries up or down, including entries added by other mods.
  • Less clutter: move unwanted entries into a collapsible group at the bottom. Restore them whenever you want.

English and Korean UI text are included. The default English hint is “Click for more info” followed by “Caw!”

Edit the list

  1. Open the inventory and click the raven to open the Compendium.
  2. Click Edit order. Use the arrows to move entries and − to collapse them.
  3. Expand Collapsed entries at the bottom and use + to restore an entry.
  4. Click Done when finished. Changes save automatically.

Reset restores the default layout for currently available entries. Editing uses the mouse or virtual pointer. With a gamepad, select Collapsed entries and press A to expand or fold the group.

Configuration

Created after the first launch: BepInEx/config/sighsorry.ReferToCompendium.cfg.

Setting Default Description
Raven hint / Enabled true Show or hide the hint. Takes effect immediately.
Raven hint / Text Empty Custom message. Leave empty for the default English or Korean message based on the game language.

All settings are local to your client.

Saved layout

Your entry order and collapsed entries are saved automatically in one shared layout. All characters and modpack profiles using the same Valheim user data folder share these preferences.

The layout is stored separately from the mod config. On Windows:

%USERPROFILE%\AppData\LocalLow\IronGate\Valheim\ReferToCompendium\layout-shared.json

Switching, moving, or renaming a modpack profile keeps your preferences. Entries from removed mods retain their saved order and collapsed state for when they return.

Back up this folder to transfer your preferences to another PC; Steam Cloud sync is not guaranteed.

Compatibility

Uses the existing Compendium entries and their content. Mods that replace the Compendium UI may need additional support. Renamed or translated mod titles can be treated as new entries. Compatibility with every mod combination has not been verified in-game.

CHANGELOG

1.0.2

  • Replace the edit controls with always-available title dragging, automatic saving, and edge scrolling.
  • Fix dragging directly within the Compendium title list.
  • Keep the drag instructions and Reset button above the scrolling list.
  • Add YAML translations for the mod's UI text, with built-in English and Korean defaults.
  • Find ReferToCompendium.<Language>.yml files in plugins and config subfolders, with config and existing translation paths taking priority.
  • Include ReferToCompendium.English.yml as a translation template.

1.0.1

  • Add a single-column status effect HUD with adjustable position, scale, and row spacing.
  • Enable the column by default at (-40, -250), with scale 0.8 and row spacing 40.
  • Add a client-side Hidden effects list to hide selected HUD entries while preserving gameplay effects and Compendium information.
  • Restore the previous HUD arrangement and styling when the column is disabled. Filtering also works with the column off.

1.0.0

  • Add a persistent raven hint with English and Korean defaults.
  • Add personal compendium ordering and collapsed entries.
  • Save one shared layout across characters and modpack profiles.