path: root/docs/FEATURES.md

# SkyHanni - List of all Features

Use `/sh` or `/skyhanni` to open the SkyHanni config in game.
<details open><summary>

## Chat

</summary>

+ Options to change the player chat format (show prefix for channel 'all', hide player rank color, hide colon after
  player name, hide/change SkyBlock level format, hide/change elite position format, edit channel prefix design)
+ Using a clean chat format for player messages (removing the rank prefix, every player writes in the same color)
+ Dungeon Filter (Removing annoying chat messages from the dungeon)
+ Dungeon Boss Message hider (includes The Watcher as well)
+ Option to hide the death messages of other players, except for players who are close to the player, inside the dungeon
  or during a Kuudra fight.
+ Scan messages sent by players in all-chat for blacklisted words and greys out the message.
+ Chat peeking (holding key to display chat without opening the chat gui)
+ Compact Potion Effect Messages
+ **Arachne Chat Hider**
    + Hide chat messages about the Arachne Fight while outside of Arachne's Sanctuary
+ Option to shorten the **bestiary level-up** message.
+ Chat **Translator** - NetheriteMiner
    + Click on any chat message sent by another player to translate it to English.
+ **Sack Change** chat message hider. - hannibal2
    + Enable this option instead of Hypixel's own setting to hide the chat message while enabling mods to utilize sack
      data for future features.
+ Adds chat symbols such as iron man/bingo/nether faction like SBA had/has. - CalMWolfs
    + Will not break with emblems.
    + Optional if left or right side of name.
    + Should not break with other mods.
+ Hide the repeating fire sale reminder chat messages. - hannibal2
+ Add tab list fire sale advertisement hider. - nea
+ SkyBlock XP Chat. - Thunderblade73
    + Sends the SkyBlock XP message from the action bar into the chat.

#### Chat Filter

- Hiding annoying messages in the Hub of Hypixel (MVP player joins, other player loot boxes, prototype message,
  radiating generosity, Hypixel tournaments)
- Hiding Empty messages.
- Warping messages (Sending requests and switching servers)
- Welcome Message when entering SkyBlock.
- Powder Mining messages hider
- Winter gift messages hider
- Many other messages (Not separated into own categories yet)

</details>
<details open><summary>

## Dungeon

</summary>

+ Clicked Blocks (Showing the block behind walls AFTER clicked on a chest, Wither Essence or a lever)
+ Current milestone display.
+ Death Counter (Changing color depending on amount, hidden at 0 deaths)
+ Clean Ending (After the last dungeon boss has died, all entities and particles are no longer displayed and the music
  stops playing, but the dungeon chests are still displayed)
+ Option to exclude guardians in F3 and M3 from the clean end feature (only when sneaking)
+ Hiding damage splashes while inside the boss room (replacing a broken feature from Skytils)
+ Highlight deathmites in red color.
+ Hide Superboom TNT lying around in dungeon.
+ Hide Blessings lying around in dungeon.
+ Hide Revive Stones lying around in dungeon.
+ Hide Premium Flesh lying around in dungeon.
+ Hide Journal Entry pages lying around in dungeon.
+ Dungeon Copilot (Suggests to you what to do next in dungeon)
+ Option to hide key pickup and door open messages in dungeon.
+ Hide Skeleton Skulls lying around in dungeon.
+ Highlight Skeleton Skulls in dungeon when combining into a skeleton in orange color (not useful combined with feature
  Hide Skeleton Skull)
+ Hide the damage, ability damage and defense orbs that spawn when the healer is killing mobs.
+ Hide the golden fairy that follows the healer in dungeon.
+ Catacombs class level color in party finder inventory.
+ Visual highlight chests that have not yet been opened in the Croesus inventory.
+ Outline Dungeon Teammates. - Cad
+ Dungeon Colored Class Level. - hannibal2
    + Color class levels in the tab list. (Also hide rank colors and emblems because who needs that in dungeons anyway?)
+ Soulweaver Skull Hider in the Dungeon Object Hider. - nea
    + Hide the annoying soulweaver skulls that float around you if you have the soulweaver gloves equipped.
+ Hide particles and damage splashes during the terracotta phase in dungeons F6 and M6. - hannibal2

</details>
<details open><summary>

## Inventory

</summary>

+ Not Clickable Items
    + Mark items gray in your inventory when they are not supposed to be moved in certain GUIs, and make green lines
      around items that meet that requirement.
    + Works in:
        + In NPC sell inventories, ender chests and backpacks, salvaging in the dungeon hub, player trade
        + bazaar, action house, accessory bag, sack of sacks, fishing bag, potion bag,
        + chests on the private island, attribute fusion, equipment GUI, Rift Motes Grubber
    + Option to allow/block clicks
+ Option to change the gray-out opacity for 'Not Clickable Items'.
+ Set stack number for specific items (stars for crimson armor, minion tier, pet level, new year cake, for golden and
  diamond dungeon heads the floor number, the tier of master skull and master star, kuudra keys, skill level, and
  collection level)
+ Sack name (show short name of sacks)
+ Anvil Combine Helper (When putting an enchanted book into the first slot of the anvil, all items with the same
  enchantment are highlighted in the inventory)
+ compact star counter on all items (not only on items with dungeon stars and master stars but also on crimson armors,
  cloaks and fishing rods)
+ RNG meter features (in the catacombs RNG meter inventory show the dungeon floor number and highlight floors without a
  drop selected and highlighting the selected drop in the RNG meter inventory for slayer or catacombs)
+ Show the tuning stats in the Thaumaturgy inventory.
+ Show the amount of selected tuning points in the stats tuning inventory.
+ Highlight the selected template in the stats tuning inventory.
+ Show the stats for the tuning point templates.
+ Highlight depleted Bonzo's Masks in your inventory.
+ Highlight stuff that is missing in the SkyBlock level guide inventory.
+ **Auction Highlighter** - Highlight own items that are sold in green and that are expired in red.
+ Highlight your own lowest BIN auctions that are outbid. - hannibal2
+ **Unclaimed Rewards** - Highlight contests with unclaimed rewards in the jacob inventory.
+ **Contest Time** - Show the real time format to the farming contest description.
+ **Pet Candies Used number**
    + Works even after Hypixel removed the `10 pet candies applied` line
+ **Estimated Armor Value display**
    + Shows the price of all 4 armor pieces combined inside the wardrobe
+ Show numbers of Pocket Sack-In-A-Sack applied on a sack (Default disabled, contributed by HiZe)
+ **Bestiary overlay** - HiZe
    + Options for change number format, display time, number type and hide maxed.
    + Highlight maxed bestiaries.
+ Chest Value - HiZe
    + Shows a list of all items and their price when inside a chest on your private island.
+ In Melody's Harp, show buttons as stack size. - NetheriteMiner
    + Intended to be used with Harp Keybinds
+ Harp GUI Scale. - Thunderblade73
    + Automatically sets the GUI scale to AUTO when entering the Harp.
+ Harp Quick Restart. - Thunderblade73
    + Once you've launched the harp, quickly hit the close button in the harp menu to initiate the selected song.
+ **Quick Craft Confirmation**. - Cad
    + Require Ctrl+Click to craft items that aren't often quick crafted (e.g. armor, weapons, accessories).
    + Sack items can be crafted normally.
+ **Shift Click Equipment**. - Thunderblade73
    + This removes the need to shift-click to swap the equipment items, without the annoying "pick up animation".
+ Copy Underbid Price. - hannibal2
    + Copies the price of an item in the "Create BIN Auction" minus 1 coin into the clipboard for faster under-bidding.
+ Power Stone Guide features. - hannibal2
    + Highlight missing power stones, show their total bazaar price, and allows to open the bazaar when clicking on the
      items in the Power Stone Guide.
+ Option to make normal clicks to shift clicks in equipment inventory. - Thunderblade73
+ Show pet items XP Share and Tier Boost as small icons next to the pet in an inventory. - Thunderblade73
+ Shift Click Brewing. - Thunderblade73
    + Makes normal clicks to shift clicks in Brewing Stand inventory.
+ Low Quiver Notification. - CarsCupcake
    + This will notify you via title if your quiver is low on arrows according to chat message.
+ Added not fully completed tasks in Way to gain SkyBlock XP menus. - Thunderblade73
    + Works in the subcategories.
    + It does not work with infinite tasks.
+ Max Items With Purse. - NetheriteMiner
    + Calculates the maximum number of items that can be purchased from the Bazaar with the number of coins in your
      purse.
+ Copy Underbid Keybind. - Obsidian
    + Copies the price of the hovered item in Auction House minus 1 coin into the clipboard for easier under-bidding.
+ Gfs message after super crafting. — Zickles
    + Adding a clickable message to pick up the super crafted items from sacks.

</details>
<details open><summary>

## Item Abilities

</summary>

+ Show the **cooldown of items** in the inventory. - hannibal2
    + Option to change the item background according to the cooldown.
    + Supports dungeon mage cooldown reduction. - Cad
+ Hiding the flame particles when using the Fire Veil Wand ability.
+ Circle around the player when having the Fire Veil Wand ability active.
+ Lesser Orb of Healing Hider. - jani

</details>
<details open><summary>

## Summoning Mobs

</summary>

- Summoning Soul Display (Show the name of dropped soul lying on the ground, not working in dungeon when Skytils' "Hide
  Non-Starred Mobs Nametags" is enabled)
- Option to hide the nametag of your spawned summoning mobs.
- Option to mark the own summoning mobs in green.
- Summoning Mob Display (Show the health of your spawned summoning mobs listed in an extra GUI element and hiding the
  corresponding spawning/despawning chat messages)

</details>
<details open><summary>

## Ashfang

</summary>

- Show a cooldown when the player gets an ability block effect during the ashfang fight.
- Display a timer until Ashfang brings his underlings back to him.
- Ashfang Gravity Orbs display.
- Ashfang Blazing Souls display.
- Highlight the different ashfang blazes in their respective color.
- Option to hide all the particles around the ashfang boss.
- Option to hide the name of full health blazes around ashfang (only useful when highlight blazes is enabled)
- Option to hide damage splashes around ashfang.

</details>
<details open><summary>

## Minion

</summary>

- A display that show the last time the hopper inside a minion has been emptied.
- A marker to the last opened minion for a couple of seconds (seen through walls)
- Option to hide mob nametags close to minions.
- Minion hopper coins per day display (Using the held coins in the hopper and the last time the hopper was collected to
  calculate the coins a hopper collects in a day)
- Minion name display with minion tier.
- **Minion Craft Helper** - Show how many more items you need to upgrade the minion in your inventory. Especially useful
  for bingo.

+ Shows how much skill experience you will get when picking up items from the minion storage. - Thunderblade73

</details>
<details open><summary>

## Bazaar

</summary>

+ Showing colors in the order inventory for outbid or fully bought/sold items.
+ Best Sell Method (Calculating the difference between instant-selling or using sell order for a selected bazaar item)
+ Saves missing items from canceled buy orders to clipboard for faster re-entry.
+ Update Timer showing when the next api data update happens.
+ Price Website button. - hannibal2
    + Adds a button to the bazaar product inventory that will open the item page in skyblock.bz.

</details>
<details open><summary>

## Fishing

</summary>

+ **Trophy Counter**
    + After fishing a new trophy fish, showing you in chat how many more trophies you have collected in total.
    + **Trophy Counter Design** - Change the way trophy fish messages gets displayed in the chat. - appable0
    + **Hide Repeated Catches** - Delete past catches of the same trophy fish from chat. - appable0
    + Show total amount of all trophy fish rarities at the end of the chat message.
    + **Trophy Fish Info** - Hover over trophy fish caught chat message to see information and stats about the trophy
      fish. - appable0
    + **Fillet Tooltip** - Adding fillet amount and price to the tooltip of a trophy fish. Left shift to show stack
      value. - appable0
+ **Hide Bronze/Silver Duplicates** - Hiding chat message when catching a duplicate bronze/silver trophy fish.
+ **Shorten Fishing Message**
    + Replacing the green chat message when fishing a sea creature with a more clean format
    + Adds **Double Hook** to the **sea creature chat message** instead of in a previous line. - appable0
+ Highlight Thunder Sparks that spawn after killing a Thunder.
+ **Barn Timer**
    + Show the time and amount of sea creatures while fishing on the barn via hub.
    + Works in crystal hollows too (worm fishing)
    + Keybind to manually reset the barn/worm fishing timer. - CarsCupcake
    + Warning sound when the worm fishing cap of 60 is hit. - CarsCupcake
    + Has support for the gamemode Stranded. - hannibal2
+ **Shark Fish Counter** - Counts how many sharks have been caught.
+ **Odger waypoint** - Show the Odger waypoint when trophy fishes are in the inventory and no lava rod in hand.
+ Showing fished item names
+ **Chum/Chumcap Bucket Hider**
    + Hide the name tags of Chum/Chumcap Bucket from other players.
    + Hide the Chum/Chumcap Bucket.
    + Hides your own Chum/Chumcap Bucket.
+ Highlight and outline feature for rare sea creatures. - Cad
+ Fishing Hook Display. - hannibal2
    + Display the Hypixel timer until the fishing hook can be pulled out of the water/lava, only bigger and on your
      screen.
+ Alerts when the player catches a Legendary Sea Creature. - Cad
+ **Fishing Bait Warnings.** - cimbraien
    + Option to warn when no bait is used.
    + Option to warn when used bait is changed.
+ Sea Creature Tracker. - hannibal2
    + Allows to only show single variants, e.g. water or lava or winter.

</details>
<details open><summary>

## Damage Indicator

</summary>

- Show the remaining health of selected bosses in the game in a bigger GUI.
- Send a chat message when the boss is healing himself.
- Option to hide or shorten the boss name above the health display.
- Specify for what bosses the damage indicator should be used.
- Option to hide the damage splash around the damage indicator (Supporting the Skytils damage splash)
- Show the collected damage over time (literally the DPS) for the last few seconds.
- Show the hits during the hit phase for Voidgloom Seraphs.
- Show the laser phase cooldown during the Voidgloom Seraph 4 fight.
- Option to show the health of Voidgloom Seraph 4 during the laser phase (useful when trying to phase skip)
- Show when Revenant Horror 5 is about to BOOM.
- Hide the vanilla nametag of damage indicator bosses.
- Garden Pests in Damage Indicator
- **Time to Kill**
    - Show the time it takes to kill the Slayer boss.

+ **Vampire Slayer**
    + Show the amount of HP missing until the steak can be used on the vampire slayer on top of the boss.
    + Show a timer until the boss leaves the invincible Mania Circles state.
    + Show the percentage of HP next to the HP.

</details>
<details open><summary>

## Slayer

</summary>

+ Hide poor slayer drop chat messages.
+ Slayer **Mini Boss:**
    + Highlight the mob.
    + Show a line from player crosshair to the mob.
+ Enderman Slayer **Yang Glyph**:
    + Highlight the beacon in red color.
        + Supports beacon in hand and beacon flying.
    + Show timer till it explodes.
    + Show a line to the beacon. - hannibal2
    + Warning when enderman slayer beacon spawns - dragon99z
+ Highlight enderman slayer Nukekubi (Skulls) - dragon99z
+ Hide the name of the mobs you need to kill in order for the Slayer boss to spawn. Exclude mobs that are damaged,
  corrupted, runic or semi rare.
+ Cooldown when the Fire Pillar from the Blaze Slayer will kill you.
+ Custom countdown sound for the Fire Pillar timer for the Blaze Slayer.
+ Option to hide sound and entities when building the Fire Pillar for the Blaze Slayer.
+ Faster and permanent display for the Blaze Slayer daggers.
+ Mark the right dagger to use for blaze slayer in the dagger overlay.
+ Warning when the fire pit phase starts for the Blaze Slayer tier 3
+ Hide particles and fireballs near blaze slayer bosses and demons.
+ Option to remove the wrong dagger messages from chat.
+ Warning when wrong slayer quest is selected, or killing mobs for the wrong slayer.
+ **Item Profit Tracker**
    + Count items collected and how much you pay while doing slayer, calculates final profit
    + Shows the price of the item collected in chat (default disabled)
+ **Items on Ground**
    + Show item name and price over items laying on ground (only in slayer areas)
+ **Broken Hyperion Warning**
    + Warns when right-clicking with a Wither Impact weapon (e.g. Hyperion) no longer gains combat exp
    + Kill a mob with melee-hits to fix this hypixel bug
    + Only works while doing slayer
+ Title warning when picking up an expensive slayer item
+ **RNG Meter Display**
    + Display amount of bosses needed until the next RNG Meter item drops
    + Warn when no item is set in the RNG Meter
    + Hide the RNG Meter message from chat if the current item is selected
+ Vampire Slayer Features – HiZe
    + Highlight your own boss (color can be changed)
    + Change color when the boss is below 20% (can use steak) (can change color)
    + Highlight other players' boss only if you hit them (can be toggled)
    + Highlight Co-Op members' boss (you need to write their name in the config)
    + Highlight Killer Spring and Blood Ichor, TwinClaws warning
    + Sound for TwinClaws
    + Option to delay c notification and sound (in millis, configurable)
    + Draw line starting from the boss head to the Killer Spring/Blood Ichor (if the boss is highlighted)
    + Draw line starting from your crosshair to the boss head
    + Configurable to work only on your boss, on bosses hit, or on coop boss
+ Hide particles around enderman slayer bosses and mini bosses
+ Boss Spawn Warning - HiZe + hannibal2
    + Send a title when your slayer boss is about to spawn
    + Con