Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Iridium-IO authored Apr 17, 2024
1 parent 01688b7 commit 4c67c87
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
![](https://github.com/IridiumIO/VaultarHUD/blob/master/src/main/resources/mbci.png)
*For the Vault Hunters Minecraft Modpack*


Adds a HUD opposite the bounty table HUD (when you press `Tab`) that shows a similar progress bar for items towards your current vault crystal. Required items that have variants (e.g. `Oak logs`, `Birch logs`) will cycle through the options automatically.

**Installation:**
- Drop the jar file into your `mods` folder and restart the game.
- Press and hold `TAB` in game after you right-click an altar.

**Caveats**
- Probably doesn't work on servers (or will require the mod to be installed on the server as well - not tested)

Also works on multiplayer servers _even if the server doesn't have the mod installed_
- However, if the server doesn't have the mod installed, you will have to right-click an altar to update the HUD - it cannot update automatically as that requires communication with the server.



**Todo:**
- Add alternative condensed view similar to the script version, and configuration option to switch between them
- Add alternative condensed view similar to the script version, and configuration option to switch between them / show up in your inventory
- Possibly add a second overlayed progress bar in a different colour that counts items that match in your inventory
- Rebindable hotkey for showing the HUD
- Allow switching between your altar and another player's altar

![image](https://github.com/IridiumIO/VaultarHUD/assets/1491536/d50a6c43-7806-416f-9ae1-a6206f5220d8)

0 comments on commit 4c67c87

Please sign in to comment.