Merge pull request #124 from bowser0000/developmentHEADv1.8.7master

1.8.7

1 files changed, 139 insertions, 15 deletions

diff --git a/README.md b/README.md
index f5f9786..53f2472 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,21 @@ QOL changes that enhances your Hypixel Skyblock experience. Created to add featu
 
 Discord Server: https://discord.gg/QsEkNQS
 
+<details>
+<summary>Incompatibilites</summary>
+
 ## Incompatibilities
 - Old Animations <2.6.4 - Frequent crashes
 - Old Animations 2.6.4
   - Pet colors does not color slots
   - Catacombs F7 terminal solvers do not color slots
   - Enchanting solvers do not color slots
+</details>
+
+<details>
+<summary>Current Features</summary>
 
-## Current features
+## Current Features
 - Guild party desktop notifications
 - Coordinate and angle display
 - Golden T10/T6/T4 enchant display
@@ -26,15 +33,18 @@ Discord Server: https://discord.gg/QsEkNQS
 - RNGesus drop alerts
 - Click anywhere on-screen to open Maddox
 - Maddox menu keybind
+- Block starting other slayer quests
 - Slayer slain alert
-- Fishing, jerry fishing, fishing festival, spooky fishing trackers
+- Fishing, jerry fishing, fishing festival, spooky fishing, crystal hollows fishing, lava fishing, trophy fishing trackers
 - Expertise kills in fishing rod lore
+- Gemstones applied in item lore
 - Catacombs trackers
 - Dungeons puzzle solver (Riddle, trivia, blaze, creeper, water, tic tac toe, boulder, silverfish, ice walk)
 - Dungeons timer (watcher, boss, deaths, and puzzle fails)
 - Watcher ready message
-- Catacombs F7 Stage 3 solvers (Starts with letter, select all colour)
+- Catacombs F7 Stage 3 solvers (Starts with letter, select all colour, ignore arrows on sea lanterns)
 - Find correct Livid (with graphic display of HP)
+- Catacombs F6 and F7 Giant HP display
 - Use custom music in supported locations
 - Experimentation solvers (Ultrasequencer, Chronomatron, Superpairs)
 - Hide tooltips in experiment addons
@@ -49,56 +59,165 @@ Discord Server: https://discord.gg/QsEkNQS
 - API commands
 - Update checker
 - Reparty command
+- Auto accept reparty
 - Highlight Slayer Bosses
 - Highlight Arachne
+- Highlight Skeleton Masters
+- Show teammates in 30 block radius
+- Hide pet candy in pet tooltip
+- Highlighting completed commissions
+- Custom name colors
+- Crystal Hollows waypoints (with SkyblockExtras support)
+- Ability cooldowns display
+- Custom alerts based on chat
+- Predicted dungeon score display
+- Hide player armour
+- Automatically join skyblock
+- Fire pillar display
+- Chat aliases
+- Thunder/Lord Jawbus spawn alerts
+- Show when minion was last collected
+- Show amount of Magmafish if trophy fish are filleted
+</details>
 
+<details>
+<summary>Commands</summary>
 
 ## Commands
 - /dhelp - Returns this message in-game.
 - /dsm - Opens the GUI for Danker's Skyblock Mod.
-- /toggle <gparty/coords/golden/slayercount/rngesusalerts/splitfishing/ghostdisplay/chatmaddox/spiritbearalert/sceptremessages/petcolors/dungeontimer/golemalerts/expertiselore/skill50display/outlinetext/midasstaffmessages/implosionmessages/healmessages/cooldownmessages/manamessages/killcombomessages/caketimer/lowhealthnotify/lividsolver/stopsalvagestarred/notifyslayerslain/necronnotifications/bonzotimer/threemanpuzzle/oruopuzzle/blazepuzzle/creeperpuzzle/waterpuzzle/tictactoepuzzle/boulderpuzzle/silverfishpuzzle/icewalkpuzzle/watchermessage/startswithterminal/selectallterminal/clickinorderterminal/ultrasequencer/chronomatron/superpairs/hidetooltipsinaddons/pickblock/melodytooltips/highlightslayers/highlightarachne/dungeonbossmusic/bloodroommusic/dungeonmusic/list> - Toggles features. /toggle list returns values of every toggle.
+- /toggle <too many to list> - Toggles features. /toggle list returns values of every toggle.
 - /setkey <key> - Sets API key.
 - /getkey - Returns key set with /setkey and copies it to your clipboard.
-- /loot <zombie/spider/wolf/fishing/catacombs/mythological/> [winter/festival/spooky/f(1-7)/session] - Returns loot received from slayer quests or fishing stats. /loot fishing winter returns winter sea creatures instead.
-- /display <zombie/spider/wolf/fishing/catacombs/mythological/ghosts/auto/off> [winter/festival/spooky/f(1-7)/session] - Text display for trackers. /display fishing winter displays winter sea creatures instead. /display auto automatically displays the loot for the slayer quest you have active.
-- /resetloot <zombie/spider/wolf/fishing/catacombs/mythological/confirm/cancel> -  - Resets loot for trackers. /resetloot confirm confirms the reset.
-- /move <coords/display/dungeontimer/skill50/lividhp/caketimer/skilltracker/wateranswer/bonzotimer/golemtimer> <x> <y> - Moves text display to specified X and Y coordinates.
-- /scale <coords/display/dungeontimer/skill50/lividhp/caketimer/skilltracker/wateranswer/bonzotimer/golemtimer> <scale (0.1 - 10)> - Scales text display to a specified multipler between 0.1x and 10x.
+- /loot <zombie/spider/wolf/enderman/blaze/fishing/catacombs/mythological/> [winter/festival/spooky/ch/lava/trophy/f(1-7)/mm/session] - Returns loot received from slayer quests or fishing stats. /loot fishing winter returns winter sea creatures instead.
+- /display <zombie/spider/wolf/enderman/blaze/fishing/catacombs/mythological/ghosts/auto/off> [winter/festival/spooky/ch/lava/trophy/f(1-7)/mm/session] - Text display for trackers. /display fishing winter displays winter sea creatures instead. /display auto automatically displays the loot for the slayer quest you have active.
+- /resetloot <zombie/spider/wolf/enderman/blaze/fishing/catacombs/mythological/confirm/cancel> -  - Resets loot for trackers. /resetloot confirm confirms the reset.
+- /move <coords/display/dungeontimer/skill50/lividhp/caketimer/skilltracker/wateranswer/bonzotimer/golemtimer/teammatesinradius/gianthp/abilitycooldowns/dungeonscore/firepillar> <x> <y> - Moves text display to specified X and Y coordinates.
+- /scale <coords/display/dungeontimer/skill50/lividhp/caketimer/skilltracker/wateranswer/bonzotimer/golemtimer/teammatesinradius/gianthp/abilitycooldowns/dungeonscore/firepillar> <scale (0.1 - 10)> - Scales text display to a specified multipler between 0.1x and 10x.
 - /slayer [player] - Uses API to get slayer xp of a person. If no name is provided, it checks yours.
-- /skills [player] - Uses API to get skill levels of a person. If no name is provided, it checks yours.
+- /skill [player] - Uses API to get skill levels of a person. If no name is provided, it checks yours.
 - /lobbyskills - Uses API to find the average skills of the lobby, as well the three players with the highest skill average.
 - /guildof [player] - Uses API to get guild name and guild master of a person. If no name is provided, it checks yours.
 - /petsof [player] - Uses API to get pets of a person. If no name is provided, it checks yours.
 - /bank [player] - Uses API to get bank and purse coins of a person. If no name is provided, it checks yours.
 - /armor [player] - Uses API to get armour of a person. If no name is provided, it checks yours.
 - /dungeons [player] - Uses API to get dungeon levels of a person. If no name is provided, it checks yours.
+- /weight [player] [lily/farming] - Uses API to get weight of a person. If no name is provided, it checks yours. Adding lily uses lily's weight. Adding farming uses Kaeso's farming weight.
 - /importfishing - Imports your fishing stats from your latest profile to your fishing tracker using the API.
 - /sbplayers - Uses API to find how many players are on each Skyblock island.
+- /onlyslayer <zombie/spider/wolf/enderman/blaze> <1/2/3/4/5>
 - /skilltracker <start/stop/reset> - Text display for skill xp/hour.
 - /reparty - Disbands and reparties all members in the party
 - /fairysouls - Check the fairysouls of a player
 - /lobbybank - Uses API to find the average bank total of the lobby, as well the three players with the highest total money in the bank (and purse).
-- /dsmmusic <stop/reload/volume> [dungeonboss/bloodroom/dungeon] [1-100] - Stops, reloads or changes the volume of custom music.
+- /dsmmusic <stop/reload/volume> [dungeonboss/bloodroom/dungeon/p2/p3/p4/p5/hub/island/dungeonhub/farmingislands/goldmine/deepcaverns/dwarvenmines/crystalhollows/spidersden/crimsonisle/end/park] [1-100] - Stops, reloads or changes the volume of custom music.
+- /player [player] - Uses API to find skills, slayers, coins and weight of a player.
+- /reloadconfig - Reloads Danker's Skyblock Mod config.
+- /reloaddsmrepo - Reloads Danker's Skyblock Mod repository.
+- /dsmfarmlength <min coords> <max coords> - Sets coords to be used for end of farm alert.
+- /hotmof [player] - Uses API to find total powder and HotM tree of a person. If no name is provided, it checks yours.
+</details>
+
+<details>
+<summary>Keybinds</summary>
 
 ## Keybinds
 - Open Maddox menu - M by default.
 - Regular Ability - Numpad 4 by default.
 - Start/Stop Skill Tracker - Numpad 5 by default.
+</details>
+
+<details>
+<summary>Warps</summary>
+
+## Warps
+Shortcut commands that save you the time of typing the whole warp command.
+- /deep - Warps you to the Deep Caverns.
+- /nether - Warps you to the Crimson Isle.
+- /isle - Warps you to the Crimson Isle.
+- /crimson - Warps you to the Crimson Isle.
+- /mines - Warps you to the Dwarven Mines.
+- /forge - Warps you to the Dwarven Forge.
+- /crystals - Warps you to the Crystal Hollows.
+- /gold - Warps you to the Gold Mine.
+- /desert - Warps you to the Desert.
+- /spider - Warps you to the Spiders Den.
+- /barn - Warps you to the Barn.
+- /end - Warps you to the End.
+- /park - Warps you to the Park.
+- /castle - Warps you to the Hub Castle.
+- /da - Warps you to the Dark Auction.
+- /crypt - Warps you to the Crypt in the Hub.
+- /nest - Warps you to the top of the Spider's Den.
+- /void - Warps you to the Void Sepulture in the End.
+- /drag - Warps you to the Dragons Nest in the End.
+- /jungle - Warps you to the Jungle.
+- /howl - Warps you to the Howling Cave in the Park.
+- /dun - Warps you to the Dungeon Hub.
+</details>
+
+<details>
+<summary>Custom Music</summary>
 
 ## Custom Music
-1. Place a music file with the given name in the `.mincraft/config/dsmmusic` folder:
-  - Dungeon music: `dungeon.wav`
-  - Blood room music: `bloodroom.wav`
-  - Dungeon boss music: `dungeonboss.wav`
+1. Place a music file with the given name in the `.minecraft/config/dsmmusic` folder:
+  - Dungeon: `dungeon.wav`
+  - Blood room: `bloodroom.wav`
+  - Dungeon boss: `dungeonboss.wav`
+  - Dungeon hub: `dungeonhub.wav`
+  - F7 Phase 2 (Storm): `phasetwo.wav`
+  - F7 Phase 3 (Goldor): `phasethree.wav`
+  - F7 Phase 4 (Necron): `phasefour.wav`
+  - F7 Phase 5 (Wither King): `phasefive.wav`
+  - Hub: `hub.wav`
+  - Private Island: `island.wav`
+  - Farming Islands: `farmingislands.wav`
+  - Gold Mine: `goldmine.wav`
+  - Deep Caverns: `deepcaverns.wav`
+  - Dwarven Mines: `dwarvenmines.wav`
+  - Crystal Hollows: `crystalhollows.wav`
+  - Spider's Den: `spidersden.wav`
+  - Crimson Isle: `crimsonisle.wav`
+  - The End: `end.wav`
+  - The Park: `park.wav`
 2. Either run `/dsmmusic reload` or restart your game.
 3. Enable the custom music in `/dsm`.
 4. (Optional) Change the volume of the music with `/dsmmusic volume`.
 
+#### Shuffling
+By adding numbers to the end of the file, you can have multiple music files for the same area. One of them will be randomly selected (the same song could play twice in a row). For example:
+- dungeon.wav
+- dungeon1.wav
+- dungeon2.wav
+- dungeon99.wav
+</details>
+
+<details>
+<summary>Alert Regex</summary>
+
+## Alert Regex
+To replace alert text with a captured group, add `$$x$$` to the alert text, with `x` being the number of the capture group. `$$0$$` will always be replaced with the entire trigger message.
+
+For example, with the following alert
+
+Regex: `From (.*) (.*): (.*)`  
+Alert Text: `$$2$$ says $$3$$`  
+Trigger Message: `From [ADMIN] Plancke: Nice autogg`  
+
+the following alert text would appear
+
+`Plancke says Nice autogg`.
+</details>
+
+<details>
+<summary>Notes</summary>
+
 ### Notes
 - Slayer tracker for token drops and 20% chance drops uses a 12x12x12 bounding box centered on the player to detect the drops. If you are out of the range of the item drop, it will not count on the tracker.
 - API commands may take a while depending on your internet connection. The API may also go down.
 - If you use too many API commands too fast, you can and will get rate-limited.
 - Importing fishing uses your sea creature kills, which may not always be exactly correct (e.x. someone else kills your sea creature).
+</details>
 
 ### Credits to Open Source Software
 Credit to all the following open source software used in this mod.
@@ -108,3 +227,8 @@ Software | License
 [SkyblockAddons](https://github.com/BiscuitDevelopment/SkyblockAddons/) | [MIT License](https://github.com/BiscuitDevelopment/SkyblockAddons/blob/master/LICENSE)
 [Zealot Counter](https://github.com/symt/zealot-counter/) | [Apache License](https://github.com/symt/zealot-counter/blob/master/LICENSE.md)
 [NotEnoughUpdates](https://github.com/Moulberry/NotEnoughUpdates/) | [Creative Commons Public License](https://github.com/Moulberry/NotEnoughUpdates/blob/master/LICENSE)
+[HyChat](https://github.com/Moulberry/Hychat) | [Creative Commons Public License](https://github.com/Moulberry/Hychat/blob/master/LICENSE)
+[SkyblockCatia](https://github.com/SteveKunG/SkyBlockcatia) | [MIT License](https://github.com/SteveKunG/SkyBlockcatia/blob/1.8.9/LICENSE.md)
+[MatterOverdrive (Legacy Edition)](https://bitbucket.org/hrznstudio/mo-legacy-edition/) | [GNU General Public License](https://bitbucket.org/hrznstudio/mo-legacy-edition/src/1.12.2/LICENSE.md)
+[Hide Armour](https://github.com/Furgl/Hide-Armor/tree/1.15.2) | No License
+[Elite Discord Bot](https://github.com/ptlthg/EliteDiscordBot) | [MIT License](https://github.com/ptlthg/EliteDiscordBot/blob/master/LICENSE)