ReferToCompendium

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: drag Compendium entries into place, including entries added by other mods.
• Less clutter: move unwanted entries into a collapsible group at the bottom. Restore them whenever you want.
• Status HUD: show status effects in one vertical column and hide selected effects from the HUD.

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

Translations

Five UI texts use YAML translations: the default raven hint, drag instructions, Reset button, collapsed group title, and collapsed group help. English and Korean files are embedded in the mod DLL, along with YamlDotNet. No separate translation library needs to be installed.

To customize a language or add another one, create a UTF-8 file named ReferToCompendium..yml anywhere under BepInEx/plugins or BepInEx/config, including subfolders. Use the game's language name, for example:

BepInEx/config/ReferToCompendium.Korean.yml

BepInEx/config/MyTranslations/ReferToCompendium.German.yml

The download includes ReferToCompendium.English.yml. It is loaded when English is selected and can be copied and renamed as a starting point for another language. Keep your edits under BepInEx/config so a package update does not overwrite them. You only need to include the entries you want to change:

rtc_raven_hint: |-

Click for more info

Caw!

rtc_reset: Reset

| Key | Text |

| --- | --- |

| rtc_raven_hint | Default raven hint |

| rtc_drag_hint | Instructions above the Compendium list |

| rtc_reset | Reset button |

| rtc_collapsed_title | Collapsed entries heading |

| rtc_collapsed_help | Help shown when that heading is selected |

Translations are applied in this order, with later files overriding individual keys:

• Built-in English.
• The selected language's built-in translation, if included.
• ReferToCompendium..yml under BepInEx/plugins.
• ReferToCompendium..yml under BepInEx/config.
• BepInEx/config/ReferToCompendium/translations.yml, which remains supported and has highest priority.

Missing or blank entries keep the text from the previous layer. If multiple matching files exist under the same root, only the first full path in ordinal (case-sensitive) order is selected, and a warning is logged. Invalid files also produce a warning and leave the previous layer unchanged; another duplicate is not used as a fallback. Files ending in.example.yml or using other naming patterns are ignored.

Files are searched only at startup and when the game language changes. Discovery skips symbolic links and junctions. Restart the game, or switch to another language and back, to reload edits. Changing the game language also refreshes the mod's open UI.

Config names and descriptions remain in English. A custom Raven hint / Text value takes priority over translations. Text from the game and other mods is unchanged.

Edit the list

• Open the inventory and click the raven to open the Compendium.
• Hold an entry's title, drag it up or down, and release at the gold line. Each completed move saves automatically.
• Use − to collapse an entry. Expand Collapsed entries at the bottom and use + to restore it.

Click a title to read its page, or hold and drag to change its order. Hold near the list's top or bottom edge to scroll, and drop out