Please disclose if any significant portion of your mod was created using AI tools by adding the 'AI Generated' category. Failing to do so may result in the mod being removed from Thunderstore.
ReferToCompendium
Persistent raven hints, personal Compendium organization, and a configurable single-column status effect HUD with filtering. Client only.
| Last updated | 7 hours ago |
| Total downloads | 38 |
| Total rating | 0 |
| Categories | Mods Client-side AI Generated Deep North Update |
| Dependency string | sighsorry-ReferToCompendium-1.0.1 |
| Dependants | 0 other packages depend on this package |
This mod requires the following mods to function
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.2351README
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.
- 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!”
Edit the list
- Open the inventory and click the raven to open the Compendium.
- Click Edit order. Use the arrows to move entries and − to collapse them.
- Expand Collapsed entries at the bottom and use + to restore an entry.
- 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. |
| Status effects / Single column | true |
Arrange HUD effects vertically, with each icon beside its name and timer. Turning this off restores the original layout. |
| Status effects / Position | (-40, -250) |
Column position relative to the top-right corner. Negative X moves left; negative Y moves down. |
| Status effects / Scale | 0.8 |
Row size, from 0.5 to 2. Spacing is adjusted separately. |
| Status effects / Row spacing | 40 |
Distance between rows, from 20 to 150. |
| Status effects / Hidden effects | Empty | Effect keys to hide from the HUD. Leave empty to show all available effects. |
All settings are local to your client.
Status effects
Single column is enabled by default and shows a vertical list near the default minimap position. Its position stays the same in no-map worlds; it does not follow a moved or resized minimap. Effects keep their existing order.
To hide effects, enter their internal names or raw localization tokens in Hidden effects, separated by commas, semicolons, or line breaks. Matching is exact and case-sensitive. For example, Rested,Resting hides those two HUD entries. For effects added by other mods, use the keys provided in that mod's documentation or source. Localized display-name lookup is not used.
Filtering also works with Single column off. It only changes HUD visibility: the effects still apply, and the Compendium's Active effects page remains unchanged. These settings stay in the client config, separate from the saved Compendium layout.
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.
Use one status HUD layout mod at a time. When using ReferToCompendium's Single column layout:
- CompactStatusEffects: disable it and restart the game to clear its existing styling.
- MyLittleUI: disable Enable in both
Status effects - Map - ListandStatus effects - Nomap - List, plus Custom element enabled in both correspondingList elementsections.
ReferToCompendium does not change other mods' configs. StatusEffectFilter can still hide effects; an effect hidden by either filter stays hidden.