From 4c67c8755231ca3d6046f448342f1fff813c62f7 Mon Sep 17 00:00:00 2001 From: Iridium IO Date: Wed, 17 Apr 2024 21:08:16 +1000 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 171114e..075e229 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ ![](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. @@ -6,9 +8,16 @@ Adds a HUD opposite the bounty table HUD (when you press `Tab`) that shows a sim - 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)