---

📝 Description

Automatically refill your hotbar when running out of items if a replacement exists in your inventory.
Works with weapons and tools as well, refilling your slot when they break if a suitable replacement is found in your inventory.

Every feature of this mod is highly configurable individually, allowing you to customize the behavior to your liking!

✨ Features

Run out of blocks, foods, ammo, or really whatever? Hotbar Refill has got you covered!

Whenever you run out of an item in your hotbar, it will automatically search your inventory and backpack for a matching item and refill the hotbar slot!
Works with stackable items (e.g., blocks, food, arrows, etc.) as well as weapons and tools, making sure to give you only suitable replacements!

When an item gets replaced, you'll get a sound notification so you know when a refill has occurred.

The configuration is explained in details further below.

Examples of hotbar refills include:

• Running out of block to place:
  
• Running out of food to eat:
  
• Tossing away items:
  
• Breaking a tool:
  
  
• Breaking a weapon while fighting:
  
• Keeping an eye on your ammo:
  

⚙️ Configuration

Configuration is located at mods/CrystalNest_HotbarRefill/config.toml.

{
  // Sound effect configuration.
  "SoundEffect": {
    // Whether to play the sound on refill.
    "Enable": true,
    // Sound effect ID to play on refill.
    // Check the full list of in-game sounds here: https://hytalemodding.dev/en/docs/server/sounds
    "ID": "SFX_Player_Pickup_Item"
  },
  // Inventory access configuration.
  "InventoryAccess": {
    // Whether to search in the hotbar for refill items.
    "FromHotbar": false,
    // Whether to search in the backpack for refill items.
    "FromBackpack": true,
    // Whether to search in the main storage for refill items.
    "FromStorage": true,
    // Whether to search in the utility slots for refill items.
    "FromUtility": false,
    // Priority order for searching inventory sections.
    // NEVER REMOVE or ADD entries to this list, ONLY MOVE the existing ones around.
    "Priority": [
      "Storage",
      "Backpack",
      "Hotbar",
      "Utility"
    ]
  },
  // Refill behavior configuration.
  "RefillBehavior": {
    // Categories of items to automatically refill when running out.
    "Category": {
      "Tool": true,
      "Weapon": true,
      "Block": true,
      "Food": true,
      "Potion": true,
      "Other": true
    },
    // Matching strategy to use when searching for refill items.
    // If false, only exact matches will be considered.
    // If true, similar items will also be considered (e.g., any type of pickaxe for a broken pickaxe).
    "Similar": {
      "Tool": true,
      "Weapon": true,
      "Block": false,
      "Food": true,
      "Potion": false,
      "Other": true
    }
  }
}

The default values are the ones shown above. Feel free to modify them to your liking!

🗳️ Issues and suggestions

If you encounter any issues or have suggestions for new features, please open an issue on the GitHub repository or hop into our Discord server and let us know!

📜 License and right of use

Feel free to use this mod for any modpack or video, just be sure to give credit and possibly link here.
This project is published under the Crystal Nest Community License v1.

❤️ Support us