path: root/README.md

<img height="150" src="https://hysky.de/skyblocker.png" alt="skyblocker"/>

## Skyblocker

[![modrinth statistic](https://img.shields.io/modrinth/dt/skyblocker-liap?color=00AF5C&label=Download&labelColor=cecece00AF5C&logo=modrinth)](https://modrinth.com/mod/skyblocker-liap)
[![curseforge statistic](https://img.shields.io/curseforge/dt/936169?logo=curseforge&color=orange)](https://www.curseforge.com/minecraft/mc-mods/skyblocker)
[![github statistic](https://img.shields.io/github/downloads/SkyblockerMod/skyblocker/total?labelColor=cecece&color=000000&label=Download&logo=github&logoColor=black)](https://github.com/SkyblockerMod/Skyblocker/releases/latest)
 \
[![Discord](https://img.shields.io/discord/879732108745125969?logo=discord&labelColor=cecece&color=7289DA&label=)](https://discord.com/invite/aNNJHQykck)

Hypixel Skyblock Mod for Minecraft 1.21 & 1.21.1

Installation guide is [here](https://github.com/SkyblockerMod/Skyblocker/wiki/installation) or use our [Modpack](https://modrinth.com/modpack/skyblocker-modpack)
## Features

<details open>
<summary>Features</summary>

### Dungeon Features:
- **Fancy Party Finder GUI**
- **Secrets Waypoint Highlight:** Fully customizable
- **Minimap & Score**
- **Starred Mob Glow**
- **Croesus Helper:**
  - Highlight not opened chests
  - Profit calculator
- **Puzzle Solver:**
  - *Three Weirdos*
  - *Blaze*
  - *Creeper Beams*
  - *Quiz - Ouro the Omniscient*
  - *Tic Tac Toe*
  - *Waterboard*
  - *Silverfish*
  - *Ice Fill*
  - *Boulder*
  - *Simon Says Solver*
  - *Lights On*
  - Terminal:
    - *Order*
    - *Coloured Items*
    - *Item Name*
- **Rare Drop Special Effects**
- **Chest Profit Calculator**
- **F3/M3 Fire Freeze Staff Timer**
- **F3/M3 Guardian Health Display**
- **F5/M5 Livid Color Highlight**
- **Reparty:** Type /rp to reparty and enable auto-rejoin.
- **AOTV & Pearl Secret Waypoints**
- **Player Secrets Tracker**
- **Wither & Blood Door Highlight**
- **Resourcepack recoloring textures in dungeons**
- **score title and sound**
- **Prevent teammates glow during Livid**
- **Block Incorrect Terminal Clicks**
- **Hide Soulweaver Skulls**

### Kuudra Features:
- **Kuudra waypoints:**
  - *Supplies*
  - *Supply Piles*
  - *Fuel Cells*
  - *Safe Spots*
  - *Pearl*
- **No arrow poison warning**
- **Low arrow poison warning**
- **Kuudra glow**
- **Kuudra danger warning**

### Crimson Isles:
- **Dojo helper**
- **Option to increase fog radius**

### Item and Armor Customization:
- *Item Renaming*
- *Custom Armor Dye Colors*
- *Custom Armor Trims*
- *Custom Animated Dyes*

### Health and Status Bars:
- **Bars:**
  - *Health and absorption*
  - *Mana*
  - *Defense*
  - *XP*
- **Vanilla health/xp and fancy bar shown in parallel**

### Profile Viewer:
- **Skills**
- **Slayer**
- **Catacombs**
- **Container:**
  - Inventory
  - Enderchest
  - Backpack
  - Wardrobe
  - Pets
  - Accessory Bag
- **Collections**

### Dwarven Mines / Crystal Hollows / Glacite Mining:
- **Dwarven Mines Solver:**
  - Fetchur
  - Puzzler
- **Crystal Hollows:**
  - Crystal Hollows Map:
    - *Shows players location in Crystal Hollows*
    - *Highlights important waypoints in Crystal Hollows*
  - Crystal Hollows Waypoints:
    - *Shows waypoints for special locations*
    - *Find locations in chat messages*
    - *Share waypoints*
  - Metal detector helper
  - Auto-detect waypoint from chat for example when talking to king
  - Nucleus waypoints
  - Wishing compass helper
  - Treasure Chest Highlighter
  - Crystal Waypoints server-sided sharing via WebSocket
- **Glacite Tunnels:**
  - *Cold Overlay*
- **Commission HUD:**
  - *Provides information on Dwarven Mines / Crystal Hollows / Glacite Mining quests*
- **Powder HUD**
- **Ordered Waypoints**

### Rift Features:
- **Mirrorverse Waypoints**
- **Enigma soul waypoint**
- **Blobbercysts Glow**

### Spider's Den Features:
- **Hidden Relic Helper**

### Slayer Helper:
- **Vampire:**
  - Effigy Waypoints
  - Healing Melon Indicator
  - Twinclaws Ice Indicator
  - Steak Stake Indicator
- **Enderman:**
  - Beacon Highlighting
  - Yang Glyph Notification
  - Nukekubi Head Highlighting
- **Blaze Slayer:**
  - Attunement highlighting
  - Fire Pillar Countdown Notifiications
- **General:**
  - Slayer (Mini)Bosses Highlighting
  - Glow Effect Slayer Mob Highlighting

### Garden Features:
- **Farming HUD:**
  - Counter
  - Crops/min
  - Coins/h
  - Blocks/s
  - Farming Level
  - Farming XP/h
  - Yaw and Pitch
- **Visitor Helper:**
  - Buy items that visitors require from bazaar by clicking the text
  - Copy amount to clipboard
- **Disable title and chat messages for Melon/Pumpkin Dicer**
- **Basic garden mouse locking feature (set mouse sensitivity to 0)**

### Visual Enhancements:
- **Compact damage**
- **Waypoints for commissions in dwarven mines and glacite tunnels**
- **Fancy Tab HUD:** Fully configurable with a resource pack.
- **1.8 Hitbox for Lever and Farmland**
- **Hide Status Effect Overlay**
- **Personal Compactor/Deletor Preview**
- **Hide Fake Players in Social Interactions Screen**
- **Item Rarity Backgrounds:**
  - Circle or Square
- **Item Cooldown Display**
- **Configure Fire-Overlay Height**
- **End HUD Widget:**
  - Zealots:
    - *Since last eye*
    - *Total zealots kills*
    - *Avg kills per eye*
  - Endstone Protector:
    - *stage*
    - *Location*
- **Ender Nodes Helper**
- **Special Effects for rare dye drops**

### User Interface Enhancements:
- **Equipment in inventory**
- **Search overlays for bz and ah**
- **Slot Text:**
  - *Attribute Shard Info Display*
  - *Catacombs level*
  - *Collection level*
  - *Enchantment book level*
  - *Minion level*
  - *Pet level*
  - *Potion level*
  - *Prehistoric egg blocks walked*
  - *Rancher's boots speed cap*
  - *Skill level*
  - *Skyblock level*
  - *Essence Shop*
  - *Your Essence*
  - *Power Stone Guide*
  - *Stats Tuning*
  - *Collection*
  - *Community Shop*
  - *Bazaar*
- **Drill Fuel and Pickonimbus 2000 in Item Durability Bar**
- **Hotbar Slot Lock Keybind:** Select the hotbar slot you want to lock/unlock and press the lock button.
- **Item Tooltip:** (Provides information on)
  - *NPC Sell Prices*
  - *Motes Prices*
  - *Bazaar (average, lowest bin)*
  - *Auction House*
  - *Museum*
  - *Exotic Armor Identifier*
  - *Item Quality*
  - *Accessories Helper*
  - *Craft Cost*
  - *Essence Shop Price*
  - *True HEX display for dye items*
  - *Estimated Item Value*
- **Quicknav:** (Fully customizeable) Fast navigation between pets, armor, enderchest, skill, collection, crafting, enchant, anvil, warp dungeon, and warp hub.
- **Recipe Book:** Lists all Skyblock items in the vanilla recipe book, allowing you to see the recipe of the item.
- **Backpack Preview:** After clicking your backpack or enderchest once, you can hover over the backpack or enderchest and hold Shift to preview its contents.
- **New Year Cakes Helper**
- **Fancy Crafting Table**
- **Info Screen**
- **Fancy Auctions Browser**
- **Calendar Event Notifications**
- **Sign calculator**

### Barn Features:
- **Barn Solver:**
  - *Treasure Hunter*
  - *Hungry Hiker*

### Chat Features:
- **Custom Chat Rules**
- **Warp command auto-complete**
- **Hide Messages:**
  - *Ability Cooldown*
  - *Heal*
  - *Aspect of the End (AOTE)*
  - *Implosion*
  - *Molten Wave*
  - *`/show command`*
  - *Teleport Pad Messages*
  - *Sky Mall*

### Miscellaneous Helpers:
- **Experiments Solvers**
- **Fishing:**
  - Helper (Includes sound notifications)
  - Fishing rod timer (change color after 20 seconds)
  - Hide other rods
- **Mythological Ritual Helper**
- **Chocolate factory Helper**
- **Jerry timer**

### Miscellaneous Features:
- **[Roughly Enough Items (REI)](https://modrinth.com/mod/rei), [EMI](https://modrinth.com/mod/emi) and [JEI](https://modrinth.com/mod/jei/) Support**
- **Item Protection**
- **Discord Rich Presence:** Allows users to show their Piggy, Bits, or location, along with a custom message.
- **Wiki Lookup:** Press F4 to open the wiki page about the held item.
- **OptiFabric Compatibility**
- **Waypoints API**
- **Config Button in Skyblock Menu**
- **Chest Value**
- **Add useful tips in chat**
- **Suppress badlion packet warnings**
- **Remove screens when switching island**
- **Skin transparency correction**
- **Skyblock XP Messages**

</details>

___

## Commands

|            command             |                                       option                                       | comment                                                                                                                                                                                                                                                                                   |
|:------------------------------:|:----------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|          /skyblocker           |                                                                                    | opens info screen                                                                                                                                                                                                                                                                         |
|       /skyblocker config       |                                                                                    | open config menu (modMenu not needed)                                                                                                                                                                                                                                                     |
|      /skyblocker options       |                                                                                    | open config menu (modMenu not needed)                                                                                                                                                                                                                                                     |
|        /skyblocker hud         |                       dwarven / dungeonmap / titleContainer                        | move dwarven, dungeonmap or titleContainer                                                                                                                                                                                                                                                |
|     /skyblocker shortcuts      |                                                                                    | add/edit shortcuts                                                                                                                                                                                                                                                                        |
|       /skyblocker custom       |                         renameItem /  armorTrim / dyeColor                         | Item and Armour customisation                                                                                                                                                                                                                                                             |
|    /skyblocker protectItem     |                                                                                    | When an item is protected it's safe from: <br /> - Being dropped while holding it, regardless of the slot being locked <br /> - Being dropped from picking it up in your inventory then clicking outside the screen <br /> - Being dropped via hovering over it and pressing the drop key |
| /skyblocker   dungeons secrets | addWaypoint \| addWaypointRelatively \[pos\] \[secretIndex\] \[category\] \[name\] |                                                                                                                                                                                                                                                                                           |
| /skyblocker   dungeons secrets |                 removeWaypoint \| removeWaypointRelatively \[pos\]                 |                                                                                                                                                                                                                                                                                           |
| /skyblocker custom animatedDye |         \[\<hex1\>\] \<hex2\> \<samples\> \<cycleBack\> \[\<tickDelay\>\]          | apply a custom animated dye to your armour <br/>  Ex: /skyblocker custom animatedDye 0061ff 60efff 10 true 4                                                                                                                                                                              |
---

## Images

<details open>
<summary>open</summary>

<img padding="10px,0px"  src="https://user-images.githubusercontent.com/27798256/170806938-f858f0ae-4d8b-4767-9b53-8fe5a65edf56.png"  alt=""/>
<img padding="10px,0px" height="150" src="https://hysky.de/minimap.png"  alt=""/>
<img padding="10px,0px" height="150" src="https://hysky.de/tooltip1.png"  alt=""/>
<img padding="10px,0px" height="150" src="https://hysky.de/tooltip2.png" alt="" />
<img padding="10px,0px" height="150" src="https://hysky.de/drill.png"  alt=""/>
<img padding="10px,0px" height="150" src="https://hysky.de/richpresencesmall.png"  alt=""/>
<img padding="10px,0px" height="150" src="https://hysky.de/recipe.png" alt="" />
<img padding="10px,0px" height="150" src="https://hysky.de/backpack-preview.png" alt="" />
<img padding="10px,0px" height="150" src="https://hysky.de/armour_trim.png" alt="" />
</details>

## Contribute

Everyone can contribute to Skyblocker, read [this](https://github.com/SkyblockerMod/Skyblocker/wiki/Contribute) for more
information.

## Stargazers

[![Stargazers repo roster for @LifeIsAParadox/Skyblocker](https://bytecrank.com/nastyox/reporoster/php/stargazersSVG.php?user=skyblockermod&repo=skyblocker)](https://github.com/SkyblockerMod/Skyblocker/stargazers)

## Credits

### Contributor

<table>
  <tr>
    <td width="150" align="center">
      <a href="https://github.com/Kraineff">
        <img alt="Kraineff" src="https://github.com/Kraineff.png" width="100">
        <br>Kraineff
      </a>
    </td>
    <td width="150" align="center">
      <a href="https://github.com/d3dx9">
        <img alt="d3dx9" src="https://github.com/d3dx9.png" width="100">
        <br>d3dx9
      </a>
    </td>
    <td width="150" align="center">
      <a href="https://github.com/LifeIsAParadox">
        <img alt="LifeIsAParadox" src="https://github.com/LifeIsAParadox.png" width="100">
        <br>LifeIsAParadox
      </a>
    </td>
    <td width="150" align="center">
      <a href="https://github.com/ExternalTime">
        <img alt="ExternalTime" src="https://github.com/ExternalTime.png" width="100">
        <br>ExternalTime
      </a>
    </td>
  </tr>
  <tr>
    <td width="150" align="center">
      <a href="https://github.com/Zailer43">
        <img alt="Zailer43" src="https://github.com/Zailer43.png" width="100">
        <br>Zailer43
      </a>
    </td>
    <td width="150" align="center">
      <a href="https://github.com/TacoMonkey11">
        <img alt="TacoMonkey11" src="https://github.com/TacoMonkey11.png" width="100">
        <br>TacoMonkey11
      </a>
    </td>
    <td width="150" align="center">
      <a href="https://github.com/KonaeAkira">
        <img alt="KonaeAkira" src="https://github.com/KonaeAkira.png" width="100">
        <br>KonaeAkira
      </a>
    </td>
    <td width="150" align="center">
      <a href="https://github.com/Fix3dll">
        <img alt="Fix3dll" src="https://github.com/Fix3dll.png" width="100">
        <br>Fix3dll
      </a>
    </td>
  </tr>
  <tr>
    <td width="150" align="center">
      <a href="https://github.com/ADON15c">
        <img alt="ADON15c" src="https://github