You are viewing a potentially older version of this package. View all versions.
ronaldoniz-FavoriteItems-1.2.0 icon

FavoriteItems

Mark inventory stacks as favorites with Alt-click. Includes a public API, with integrations for major inventory mods in development.

Date uploaded a month ago
Version 1.2.0
Download link ronaldoniz-FavoriteItems-1.2.0.zip
Downloads 640
Dependency string ronaldoniz-FavoriteItems-1.2.0

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2350 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.2350

README

FavoriteItems for Valheim

Keep important inventory stacks safe from automatic movement with a simple favorite marker.

Features

  • Mark or unmark a stack with Alt + left-click.
  • See favorites at a glance with a subtle golden star.
  • Keep favorite items out of supported automatic inventory actions.
  • Optionally protect supported special-slot inventories without favoriting their items.
  • Preserve favorites when saving, moving, splitting, or merging stacks.
  • Provide a public API for compatible inventory and quick-stack mods.
  • Use the mod client-side without requiring it on the server.

How to use

  1. Open your inventory.
  2. Hold the left or right Alt key.
  3. Left-click an item stack.

The golden star means that the stack is protected. Repeat the same action to remove the favorite.

Installation

Thunderstore Mod Manager or r2modman

Install FavoriteItems from the Valheim community and launch the game through your mod manager.

Manual installation

Install BepInEx 5, then place FavoriteItems.dll at:

<Valheim>\BepInEx\plugins\ronaldoniz-FavoriteItems\FavoriteItems.dll

The configuration file is created at:

BepInEx\config\com.ronaldo.valheim.favoriteitems.cfg

Compatibility

  • GorilaChestMod 2.4.0: favorite stacks are not moved during quick stack.
  • EquipmentAndQuickSlots 3.x: equipment and quick-slot cells can be protected automatically, even without a favorite marker, when the compatibility option is enabled.
  • ExtraSlots 1.2.3: manual favorites work in regular and special slots. Special-slot items can also be protected automatically, even without a favorite marker, when its compatibility option is enabled.
  • All listed mods are optional. FavoriteItems continues to work when they are absent.

Favorites are currently guaranteed to block automatic movement only in the supported GorilaChestMod integration. Other inventory and quick-stack mods require their own integration.

Configuration

  • Enable or disable the favorite system.
  • Show or hide the golden star.
  • Show or hide favorite notifications.
  • Enable optional automatic EquipmentAndQuickSlots protection. This is disabled by default for new installations so that unmarked items behave predictably.
  • Enable optional automatic ExtraSlots protection. This is also disabled by default.

For mod authors

FavoriteItems provides a small public API to query or change favorites, block automatic movement, and register protected-slot providers. The API reference includes direct-reference and optional-integration examples.

Known limitations

  • The shortcut currently supports keyboard and mouse only.
  • Quick-stack protection is currently specific to GorilaChestMod.
  • EquipmentAndQuickSlots protection depends on its current public IsSlotCell API.
  • ExtraSlots protection depends on its current public IsItemInSlot API.

Source and support

FavoriteItems is open source under the MIT License. Source code, releases, and issue reporting are available on GitHub.

Tip jar

Liked the mod? You can leave a small tip on Ko-fi — completely optional, always appreciated.

CHANGELOG

Changelog

1.2.0

  • Added optional automatic protection for ExtraSlots 1.2.3 special slots.
  • Integrated ExtraSlots through its public IsItemInSlot API without making it a required dependency.
  • Kept automatic protection disabled by default so unstarred special-slot items continue to move unless explicitly protected.

1.1.0

  • Added a stable public API for querying and changing favorite state.
  • Added a unified automatic-movement policy for quick-stack integrations.
  • Added protection-provider registration for equipment and additional-slot mods.
  • Refactored GorilaChestMod and EquipmentAndQuickSlots support to use the shared API policy.
  • Changed automatic EquipmentAndQuickSlots protection to opt-in for new configurations.
  • Added an unpublished development test mod for API contract and failure-isolation checks.

1.0.2

  • Translated all in-game notifications, configuration descriptions, and log messages into English.
  • Added a packaging check to prevent the previously used Portuguese runtime phrases from returning.
  • Established English as the required language for public documentation and user-facing text.
  • Refocused the package README on players and moved contributor details to DEVELOPMENT.md.

1.0.1

  • Fixed patch loading for InventoryGrid.OnLeftDown on Valheim 1.0.7.
  • Harmony now identifies method arguments by position instead of relying on internal names.

1.0.0

  • Added Alt + left-click to toggle favorite state in the player inventory.
  • Added a subtle golden star to favorite slots.
  • Added persistence through ItemData.m_customData without preventing vanilla stack merging.
  • Preserved favorite state safely when splitting and merging stacks.
  • Added quick-stack protection for GorilaChestMod 2.2.2.
  • Added optional automatic protection for EquipmentAndQuickSlots 3.x slots.