aboutsummaryrefslogtreecommitdiff
path: root/MRREADME.md
diff options
context:
space:
mode:
Diffstat (limited to 'MRREADME.md')
-rw-r--r--MRREADME.md513
1 files changed, 416 insertions, 97 deletions
diff --git a/MRREADME.md b/MRREADME.md
index 7e1e68ad..67dd29b2 100644
--- a/MRREADME.md
+++ b/MRREADME.md
@@ -2,7 +2,7 @@
## Skyblocker
-Hypixel Skyblock Mod for Minecraft 1.17.x + 1.18.x + 1.19.x + 1.20.x
+Hypixel Skyblock Mod for Minecraft 1.20.2
## 🔧 Configuration - [Mod Menu](https://modrinth.com/mod/modmenu) not required
open config with modmenu \
@@ -10,17 +10,31 @@ or **/skyblocker config**
Skyblocker has a variety of configurations. \
To access the configuration menu, you must install [Mod Menu](https://modrinth.com/mod/modmenu).
-<figure><a href="https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/7a284adbbdc9cbad48c627e3898dc8cfb9f54a64.png"><img src="https://cdn.modrinth.com/data/y6DuFGwJ/images/7a284adbbdc9cbad48c627e3898dc8cfb9f54a64.png" alt="Mod Menu" style="width:100%"></a><figcaption align = "center"><b>Mod Menu - Skyblocker config</b></figcaption></figure>
+<figure><a href="https://cdn.discordapp.com/attachments/895564321520750602/1165269183429361674/Bildschirmfoto_vom_2023-10-21_14-43-26.png"><img src="https://cdn.discordapp.com/attachments/895564321520750602/1165269183429361674/Bildschirmfoto_vom_2023-10-21_14-43-26.png" alt="Mod Menu" style="width:100%"></a><figcaption align = "center"><b>Skyblocker config</b></figcaption></figure>
### List of Configuration
<details>
<summary> General </summary>
-|Config option|Description|
-|---|---|
-| Update Notification | Get notified when there is a new update |
-| View [backpack preview](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/ef33e34b79c1615bcb23f3a395b29b793ef32e34.png) without holding shift | Preview on hover |
+| Config option | Description |
+|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
+| Auto accept Reparty | Auto accept Reparty |
+| View [backpack preview](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/ef33e34b79c1615bcb23f3a395b29b793ef32e34.png) without holding shift | Preview on hover |
+| Enable Comactor/Deletor Preview | Preview on hover |
+| Hide empty item tooltips in menus | |
+| Hide Status Effect Overlay | |
+
+<details>
+<summary> Fancy tab HUD </summary>
+
+| Config option | Description |
+|-------------------------------|---------------------------------------------------------------------------|
+| Enable fancy tab HUD | |
+| Scale factor of fancy tab HUD | |
+| Plain Player Names | display names without any special formatting |
+| Player Name Sorty Method | default has no particular order. Alphabetical sort names alphabetically |
+</details>
<details>
<summary> Health, Mana, Defence & XP Bars </summary>
@@ -32,11 +46,74 @@ To access the configuration menu, you must install [Mod Menu](https://modrinth.c
</details>
<details>
+<summary> Experiments Solver </summary>
+
+| Config option | Description |
+|------------------------------|-------------|
+| Enable Chromatron Solver | |
+| Enable Superpairs Solver | |
+| Enable Ultrasequencer Solver | |
+
+</details>
+
+<details>
+<summary> Fishing Helper </summary>
+
+| Config option | Description |
+|-----------------------|-------------|
+| Enable Fishing Helper | |
+
+</details>
+
+<details>
+<summary> Fairy Souls Helper </summary>
+
+| Config option | Description |
+|-----------------------------------|---------------------|
+| Enable Fairy Souls Helper | |
+| Highlight found fairy souls | |
+| Only highlight nearby fairy souls | radius of 50 blocks |
+
+</details>
+
+<details>
+<summary> Item Cooldown </summary>
+
+| Config option | Description |
+|----------------------|---------------------|
+| Enable Item Cooldown | |
+
+</details>
+
+<details>
+<summary> Shortcuts </summary>
+
+| Config option | Description |
+|-----------------------------------|----------------------------------------|
+| Enable Shortcuts | |
+| Enable Command Shortcuts | |
+| Enable Command Argument Shortcuts | |
+| Shortcuts Config | Open new window to configure shortcuts |
+
+</details>
+
+<details>
+<summary> Quiver Warning </summary>
+
+| Config option | Description |
+|---------------------------------------|----------------------------------------|
+| Enable Quiver Warning | |
+| Enable Quiver Warning In Dungeons | |
+| Enable Quiver Warning After a Dungeon | |
+
+</details>
+
+<details>
<summary> Item List </summary>
-|Config option|Description|
-|---|---|
-|Enable Item List| Acitvate [recipe viewer](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/cf9f8077067b9781686f23116f163d529c21c404.png)|
+| Config option | Description |
+|------------------|--------------------------------------------------------------------------------------------------------------------------|
+| Enable Item List | Acitvate [recipe viewer](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/cf9f8077067b9781686f23116f163d529c21c404.png) |
</details>
<details>
@@ -44,54 +121,244 @@ To access the configuration menu, you must install [Mod Menu](https://modrinth.c
Customize [Item tooltip](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/12903f3f839d769fac48a4e74e04bee9aa1657d5.png)
+| Config option | Description |
+|------------------------------|----------------------------------------|
+| Enable NPC Price | |
+| Enable Motes Price | |
+| Enable Avg. BIN Price | |
+| Average Type | |
+| Enable Lowest BIN Price | |
+| Enable Bazaar buy/sell Price | |
+| Enable Museum & Date | |
+
+</details>
+
+<details>
+<summary> Item Info Display </summary>
+
+| Config option | Description |
+|--------------------------------|-------------|
+| Attribute Shard Info | |
+| Item Rarity Backgrounds | |
+| Item Rarity Background Opacity | |
+</details>
+
+<details>
+<summary> Wiki Lookup </summary>
+
+| Config option | Description |
+|--------------------|-----------------------------------------------------|
+| Enable Wiki Lookup | press f4 to open the wiki page pof the hovered item |
+| Use Official Wiki | |
+</details>
+
+<details>
+<summary> Special Effects </summary>
+
+| Config option | Description |
+|---------------------------|-------------|
+| Rare Dungeon Drop Effects | |
</details>
<details>
<summary> Hitboxes </summary>
-|Config option|Description|
-|---|---|
-|Enable 1.8 farmland hitbox| Change hitbox to the 1.8 one |
-|Enable 1.8 lever hitbox| Change hitbox to the 1.8 one |
+| Config option | Description |
+|----------------------------|------------------------------|
+| Enable 1.8 farmland hitbox | Change hitbox to the 1.8 one |
+| Enable 1.8 lever hitbox | Change hitbox to the 1.8 one |
</details>
+
+<details>
+<summary> Title Container </summary>
+
+Used to display multiple titles at once, Example use: Vampire Slayer
+
+| Config option | Description |
+|----------------------------------|-------------|
+| Title Container Scale | |
+| Title Container Placement Config | |
</details>
<details>
-<summary> Locations </summary>
+<summary> Teleport Overlay </summary>
+
+| Config option | Description |
+|---------------------------------------|-------------|
+| Enable Teleport Overlays | |
+| Enable Weird Transmission Overlay | |
+| Enable Instant Transmission Overlay | |
+| Enable Ether Transmission Overlay | |
+| Enable Sinrecall Transmission Overlay | |
+| Enable Wither Impact Overlay | |
+</details>
+
+<details>
+<summary> Flame Overlay </summary>
+
+| Config option | Description |
+|---------------|-------------|
+| Flame Height | |
+| Flame Opacity | |
+</details>
+
+</details>
<details>
<summary> Dungeons </summary>
-|Config option|Description|
-|---|---|
-|Croseus Helper|Gray out chests that have already been opened|
-|Enable Map| [Map](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/43243429b1c4d17236ae3e5a9836ecd7d905644b.png)|
-|Solve Three Weirdos Puzzle|Solver usefull in Dungeons|
-|Solve Blaze Puzzle|Solver usefull in Dungeons|
-|Solve Trivia Puzzle|Solver usefull in Dungeons|
+| Config option | Description |
+|------------------------------|--------------------------------------------------------------------------------------------------------|
+| Croseus Helper | Gray out chests that have already been opened |
+| Enable Map | [Map](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/43243429b1c4d17236ae3e5a9836ecd7d905644b.png) |
+| Dungeon Map Placement Config | |
+| Map Scaling | |
+| Starred Mob Glow | |
+| Solve Three Weirdos Puzzle | Solver usefull in Dungeons |
+| Solve Blaze Puzzle | Solver usefull in Dungeons |
+| Solve Creeper Beams Puzzle | |
+| Solve Trivia Puzzle | Solver usefull in Dungeons |
+| Solve Tic Tac Toe Puzzle | |
<details>
-<summary> Terminal </summary>
+<summary> Dungeon Secret Waypoints </summary>
+
+| Config option | Description |
+|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Enable Dungeon Secret Waypoints | |
+| Do Not Initialize Secret Waypoints | |
+| Waypoint Type | Waypoint: Displays a highkught and beam <br/>Outlined Waypoint: Displays both a waypoint and an outline <br/> Highlight: Only displays a highlight <br/> Outlined Highlight: Displays both a highlight and an outline <br/> Outline: Outlines the secret in a box. |
+| Show Secret Text | |
+| Enable Entrance Waypoints | |
+| Enable Superboom Waypoints | |
+| Enable Chest Waypoints | |
+| Enable Item Waypoints | |
+| Enable Bat Waypoints | |
+| Enable Wither Essence Waypoints | |
+| Enable Lever Waypoints | |
+| Enable Fairy Soul Waypoints | |
+| Enable Stonk Waypoints | |
+| Enable Default Waypoints | |
+</details>
-|Config option|Description|
-|---|---|
-|Solve Selectect Colored|Solver usefull in Dungeons 7|
-|Solve Click In Order|Solver usefull in Dungeons 7|
-|Solve Starts With|Solver usefull in Dungeons 7|
+<details>
+<summary> Dungeon Chest Profit Calculator </summary>
+
+| Config option | Description |
+|--------------------------|-------------|
+| Enable Profit Calculator | |
+| Include Kismet Price | |
+| Include Essence | |
+| Neutral Threshold | |
+| Neutral Color | |
+| Profit Color | |
+| Loss Color | |
+| Incomplete Color | |
+</details>
+
+<details>
+<summary> Livid Color </summary>
+
+| Config option | Description |
+|--------------------|----------------------------------------------------------|
+| Enable Livid Color | Send the livid color in chat during the Livid boss fight |
+| Livid Color Text | text wich will be sent in the chat |
+</details>
+
+<details>
+<summary> Terminal Solvers </summary>
+
+| Config option | Description |
+|-------------------------|------------------------------|
+| Solve Selectect Colored | Solver usefull in Dungeons 7 |
+| Solve Click In Order | Solver usefull in Dungeons 7 |
+| Solve Starts With | Solver usefull in Dungeons 7 |
</details>
+
</details>
+
<details>
<summary> Dwarven Mines </summary>
-|Config option|Description|
-|---|---|
-|Enable Drill Fuel|[Drill icon](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/43c7ab7aa7c90fcf833c7cddbf73e6644c6ce5fa.png)|
-|Solve Fetchur| Solver usefull in Mines|
-|Solve Puzzler Puzzle| Solver usefull in Mines |
-|Dwarven Hud| [Commision Hud](https://cdn.discordapp.com/attachments/905867886428565565/950513333478494248/Screen_Shot_2022-03-07_at_4.58.12_PM.png)|
+| Config option | Description |
+|----------------------|----------------------------------------------------------------------------------------------------------------------------------------|
+| Enable Drill Fuel | [Drill icon](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/43c7ab7aa7c90fcf833c7cddbf73e6644c6ce5fa.png) |
+| Solve Fetchur | Solver usefull in Mines |
+| Solve Puzzler Puzzle | Solver usefull in Mines |
+
+<details>
+<summary> Dwarven HUD </summary>
+
+| Config option | Description |
+|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Enabled | |
+| Style for HUD | Simple: Shows name and percentage<br/> Fancy: Shows name, percentage, progress bar and an icon <br/> Classic: Shows name and percentage in a very simple box |
+| Dwarven HUD Config... | |
+| Enable Background | |
+
+</details>
+
+</details>
+
+<details>
+<summary> Locations </summary>
+
+<details>
+<summary> Barn </summary>
+
+| Config option | Description |
+|:----------------------|:------------|
+| Solve Hungry Hiker | |
+| Solve Treasure Hunter | |
+
+</details>
+
+<details>
+<summary> The Rift </summary>
+
+| Config option | Description |
+|:-----------------------------|:---------------------------------------|
+| Enable Mirrorverse Waypoints | |
+| McGrubber Sacks | Used for calculating Motes sell prices |
+
+</details>
+
+<details>
+<summary> Spider's Den </summary>
+
+| Config option | Description |
+|:----------------------------|:------------|
+| Enable Hidden Relics Helper | |
+| Highlight found relics | |
+
</details>
+
</details>
+<details>
+<summary> Slayers </summary>
+
+<details>
+<summary> Vampire Slayer </summary>
+
+| Config option | Description |
+|:-----------------------------------------------|:------------|
+| Enable Effigy Waypoints | |
+| Compact Effigy Waypoints | |
+| Effigy Waypoints Update Frequency (Ticks) | |
+| Enable Holy Ice Indicator | |
+| Holy Ice Indicator Delay (Ticks) | |
+| Holy Ice Indicator Update Frequency (Ticks) | |
+| Enable Healing Melon Indicator | |
+| Healing Melon Indicator Threshold (Hearts) | |
+| Enable Steak Stake Indicator | |
+| Steak Stake Indicator Update Frequency (Ticks) | |
+| Enable Mania Block Indicator | |
+| Mania Indicator Update Frequency (Ticks) | |
+
+</details>
+
+</details>
<details>
<summary> Quick Navigation </summary>
@@ -112,25 +379,24 @@ Customize [Item tooltip](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/12903
</details>
</details>
-
<details>
<summary> Messages </summary>
-|Config option|Description|
-|---|---|
-|Hide Ability Cooldown|Disable,Filter or Move to action bar|
-|Hide Heal Messages|Disable,Filter or Move to action bar|
-|Hide AOTE Messages|Disable,Filter or Move to action bar|
-|Hide Implosion Message|Disable,Filter or Move to action bar|
-|Hide Molten Wave Message|Disable,Filter or Move to action bar|
-|Hide Ads from Public Chat|Disable,Filter or Move to action bar|
-|Hide Teleport Pad Messages|Disable,Filter or Move to action bar|
-|Hide Combo Messages|Disable,Filter or Move to action bar|
-|Hide Autopet Messages|Disable,Filter or Move to action bar|
-|Hide Mana Consumption Messages from Action Bar|Activate or deactivate|
+| Config option | Description |
+|------------------------------------------------|-----------------------------------------|
+| Hide Ability Cooldown | Disable,Filter or Move to action bar |
+| Hide Heal Messages | Disable,Filter or Move to action bar |
+| Hide AOTE Messages | Disable,Filter or Move to action bar |
+| Hide Implosion Message | Disable,Filter or Move to action bar |
+| Hide Molten Wave Message | Disable,Filter or Move to action bar |
+| Hide Ads from Public Chat | Disable,Filter or Move to action bar |
+| Hide Teleport Pad Messages | Disable,Filter or Move to action bar |
+| Hide Combo Messages | Disable,Filter or Move to action bar |
+| Hide Autopet Messages | Disable,Filter or Move to action bar |
+| Hide Show Off Messages | Filters messages from the `/show command` |
+| Hide Mana Consumption Messages from Action Bar | Activate or deactivate |
</details>
-
<details>
<summary> Discord Rich Presence </summary>
@@ -146,58 +412,111 @@ Customize [Item tooltip](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/12903
Click [#Gallery](https://modrinth.com/mod/skyblocker-liap/gallery) for images to this mod
## 📖Features
-<details open>
+<details open>
<summary>open</summary>
-* Bars: Health and absorption, Mana, Defense, XP (moving fancy bars)
-* Hide Messages: Ability Cooldown, Heal, AOTE, Implosion, Molten Wave, Teleport Pad Messages
-* Dungeon Minimap
-* Dungeon Secrets
-* Starred Mob Glow
-* Dungeon Puzzle Solver:
- * Three Weirdos
- * Blaze
- * Tic Tac Toe
- * Croesus
- * Terminal:
- * Order
- * Coloured Items
- * Item Name
-* Dwarven Mines Solver: Fetchur, Puzzler
-* Barn Solver: Treasure Hunter, Hungry Hiker
-* Experiments Solvers
-* Slayer helper:
- * Vampire : Effigy Waypoints, Healing Melon Indicator, Twinclaws Ice Indicator, Steak Stake Indicator
-* 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 lockbutton)
-* Price tooltip: npc, motes, bazaar (avg, lbin), ah, museum
-* reparty: write /rp to reparty + auto rejoin
-* Wiki Lookup: press f4 to open the wiki page about the held item
-* Discord Rich Presence: Allows user to show either their Piggy, Bits, or location. Along with a custom message
-* Quicknav: fast navigate between pets, armor, enderchest, skill, collection, crafting, enchant, envil, warp dungeon,
- warp hub
-* Recipe book: in the vanilla recipe book all skyblock items are listed, and you can see the recipe of the item
-* Backpack preview: after you clicked your backpack or enderchest once you can hover over the backpack or enderchest and
- hold shift to preview
-* Update notification
-* Commission HUD: Dwarven Mines quests
-* 1.8 hitbox for lever and farmland
-* Custom Tab HUD + Fully configureable with ressourcepack
-* Roughly enough items (REI) and Emi Support
-* Fishing Helper + sound notification
-* Mirrorverse Waypoints
-* Attribute Shard Info Display
-* Item and Armour customisation:
- * Item Renaming
- * Custom Armour Dye Colours
- * Custom Armour Trims
-* OptiFabric Compatibility
-* Rare Drop Special Effects! Dungeon chest
-* Dungeon Chest Profit Calculator
-* Hide Status Effect Overlay
-* Personal Compactor/Deletor preview
-* Hide fake players in social interactions screen
-* hidden relic helper
+### Dungeon Features:
+- **Secrets Highlight:** Fully configurable
+- **Minimap**
+- **Starred Mob Glow**
+- **Puzzle Helper:**
+ - *Croesus*
+ - *Three Weirdos*
+ - *Blaze*
+ - *Creeper Beams*
+ - *Trivia*
+ - *Tic Tac Toe*
+ - *Terminal:*
+ - *Order*
+ - *Coloured Items*
+ - *Item Name*
+- **Rare Drop Special Effects**
+- **Chest Profit Calculator**
+- **Livid Color Helper**
+- **Reparty:** Type /rp to reparty and enable auto-rejoin.
+
+### Item and Armor Customization:
+- *Item Renaming*
+- *Custom Armor Dye Colors*
+- *Custom Armor Trims*
+
+### Health and Status Bars:
+- **Bars:**
+ - *Health and absorption*
+ - *Mana*
+ - *Defense*
+ - *XP*
+
+### Dwarven Mines:
+- **Dwarven Mines Solver:**
+ - *Fetchur*
+ - *Puzzler*
+- **Commission HUD**
+ - *Provides information on Dwarven Mines quests*
+
+### Rift Features:
+- **Mirrorverse Waypoints**
+
+### Spider's Den Features:
+- **Hidden Relic Helper**
+
+### Slayer Helper:
+- **Vampire:**
+ - *Effigy Waypoints*
+ - *Healing Melon Indicator*
+ - *Twinclaws Ice Indicator*
+ - *Steak Stake Indicator*
+
+### Visual Enhancements:
+- **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**
+- **Item Cooldown Display**
+- **Configure Fire-Overlay Height**
+
+### User Interface Enhancements:
+- **Attribute Shard Info Display**
+- **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.
+- **Price Tooltip:** (Provides information on)
+ - *NPC Prices*
+ - *Motes Prices*
+ - *bazaar (average, lowest bin)*
+ - *Auction House*
+ - *Museum*
+- **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.
+
+### Barn Features:
+- **Barn Solver:**
+ - *Treasure Hunter*
+ - *Hungry Hiker*
+
+### Chat Features:
+- **Hide Messages:**
+ - *Ability Cooldown*
+ - *Heal*
+ - *Aspect of the End (AOTE)*
+ - *Implosion*
+ - *Molten Wave*
+ - *`/show command`*
+ - *Teleport Pad Messages*
+
+### Miscellaneous Solvers:
+- **Experiments Solvers**
+- **Fishing Helper:** Includes sound notifications.
+
+### Miscellaneous Features:
+- **Roughly Enough Items (REI) and EMI 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**
+
</details>