aboutsummaryrefslogtreecommitdiff
path: root/MRREADME.md
blob: 9cf2e0c3b0afb03ba22cf33b4f2883908a8a301c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
<img height="150" src="https://hysky.de/skyblocker.png"  alt="Skyblocker logo"/>

# Skyblocker

Hypixel Skyblock Mod for Minecraft 1.20.x


## 📖 Features
<details>
<summary> Dungeon Features </summary>

- **Secrets Waypoint Highlight:** Fully customizable
- **Minimap**
- **Starred Mob Glow**
- **Croesus Helper**
- **Puzzle Solver:**
  - *Three Weirdos*
  - *Blaze*
  - *Creeper Beams*
  - *Quiz - Ouro the Omniscient*
  - *Tic Tac Toe*
  - *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**
</details>

<details>
<summary> Item and Armor Customization </summary>

- *Item Renaming*
- *Custom Armor Dye Colors*
- *Custom Armor Trims*
</details>

<details>
<summary> Health and Status Bars </summary>

- **Bars:**
  - *Health and absorption*
  - *Mana*
  - *Defense*
  - *XP*
</details>

<details>
<summary> Dwarven Mines </summary>

- **Dwarven Mines Solver:**
  - *Fetchur*
  - *Puzzler*
- **Commission HUD**
  - *Provides information on Dwarven Mines quests*
</details>

<details>
<summary> Rift Features </summary>

- **Mirrorverse Waypoints**
</details>

<details>
<summary> Spider's Den Features </summary>

- **Hidden Relic Helper**
</details>

<details>
<summary> Slayer Helper </summary>

- **Vampire:**
  - *Effigy Waypoints*
  - *Healing Melon Indicator*
  - *Twinclaws Ice Indicator*
  - *Steak Stake Indicator*
</details>

<details>
<summary> Visual Enhancements </summary>

- **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**
</details>

<details>
<summary> User Interface Enhancements </summary>

- **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.
</details>

<details>
<summary> Barn Features </summary>

- **Barn Solver:**
  - *Treasure Hunter*
  - *Hungry Hiker*
</details>

<details>
<summary> Chat Features </summary>

- **Hide Messages:**
  - *Ability Cooldown*
  - *Heal*
  - *Aspect of the End (AOTE)*
  - *Implosion*
  - *Molten Wave*
  - *`/show command`*
  - *Teleport Pad Messages*
</details>

<details>
<summary> Miscellaneous Solvers </summary>

- **Experiments Solvers**
- **Fishing Helper:** Includes sound notifications.
</details>

<details>
<summary> Miscellaneous Features </summary>

- **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>


## 🔧 Configuration
Open the config menu with **/skyblocker config**  
or through [Mod Menu](https://modrinth.com/mod/modmenu)  

### Config Options

<details>
<summary> General </summary>

| 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>

| Config option          | Description                                                                                                                                                   |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Enable Bars            | Change Minecraft health ui with skyblocker [custom ui](https://user-images.githubusercontent.com/27798256/170806938-f858f0ae-4d8b-4767-9b53-8fe5a65edf56.png) |
| Configure Bar Position | [Customize Bar Positions](https://raw.githubusercontent.com/SkyblockerMod/Skyblocker-Assets/images/Health%20and%20Status%20Bars/Status%20Bars.png)            |
</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://raw.githubusercontent.com/SkyblockerMod/Skyblocker-Assets/images/User%20Interface%20Enhancements/Recipe%20Book%202.png) |
</details>

<details>
<summary> Item Tooltip </summary>

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 |
</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> 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)  |
| 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> 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>

<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                                                                                                                |

<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>

| Config option           | Description                                                                                                                              |
|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| Enable Quick Navigation | Enable [Quicknav](https://raw.githubusercontent.com/SkyblockerMod/Skyblocker-Assets/images/User%20Interface%20Enhancements/Quicknav.png) |
<details>
<summary> Button 1-12 </summary>

| Config option | Description                                           |
|---------------|-------------------------------------------------------|
| Render        | To show the tab                                       |
| Item name     | The name of the item e.g. iron_boots                  |
| NBT           | NBT tag of the item e.g. custom head id on skull item |
| UI Title      | Title of the tab                                      |
| Click event   | The command that is executed when you click the tab   |
</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 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>

| Config option       | Description                                                                                                                      |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Enable              | Activate [Discord Rich Presence](https://cdn-raw.modrinth.com/data/y6DuFGwJ/images/f6314d0ae0fc24d77fb3371e59b7abfe4774a17e.png) |
| Skyblock Info       | Choose between Location,Purse and Bits                                                                                           |
| Cycle Skyblock Info | Cycles between the three options                                                                                                 |
| Custom Message      | Show a custom message                                                                                                            |
</details>


## 🖼️ Images
Click [#Gallery](https://modrinth.com/mod/skyblocker-liap/gallery) for images to this mod


## [Modpack](https://modrinth.com/modpack/skyblocker-modpack)

<details open>
<summary>Installation Instructions</summary>

1. [Here](https://docs.modrinth.com/docs/modpacks/playing_modpacks) is a tutorial how to install it easy with a launcher.
2. Download the [Skyblocker Modpack](https://modrinth.com/modpack/skyblocker-modpack/version/latest).
    * Drag and drop the .mrpack file into a Custom MC Launcher like [MultiMC](https://multimc.org/) or [Prism Launcher](https://prismlauncher.org/) and start the new instance.

</details>


## Kinetic Hosting Affiliate - 15% off your first month

Looking for an affordable and reliable hosting platform for your Minecraft server? Look no further than Kinetic Hosting! As an affiliate partner with Kinetic Hosting, we highly recommend their service. They offer fast and reliable servers with the largest range of supported modpacks.

As a special offer for our audience, you can **<u>[use the discount code "Skyblocker" during checkout to get 15% off your first month](https://billing.kinetichosting.net/aff.php?aff=315)</u>**.
This helps to cover our server costs.

[![Kinetic-hosting](https://raw.githubusercontent.com/SkyblockerMod/Skyblocker-Assets/images/other/Kinetic-Hosting_Skyblocker.png)](https://billing.kinetichosting.net/aff.php?aff=315)

So what are you waiting for? Click on the **<u>[link](https://billing.kinetichosting.net/aff.php?aff=315)</u>** to check out Kinetic Hosting and start playing with your friends today!