aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 38 insertions, 20 deletions
diff --git a/README.md b/README.md
index 61ebfb6..e02bbb8 100644
--- a/README.md
+++ b/README.md
@@ -9,39 +9,45 @@ Discord Server: https://discord.gg/QsEkNQS
- LabyMod + Sidebar Mod Revamp - Displays don't show
## Current features
-- Guild party desktop notifications (toggleable)
-- Coordinate and angle display (toggleable, graphic display) (scalable)
-- Golden T10/T6/T4 enchant display (toggleable)
-- Block AOTD ability (toggleable)
-- Disable Spirit Sceptre messages (toggleable)
-- Disable Midas Staff messages (toggleable)
-- Slayer item tracker (with graphic display) (scalable)
-- RNGesus drop alerts (toggleable)
-- Click in chat to open Maddox (toggleable)
-- Maddox Menu keybind
+- Guild party desktop notifications
+- Coordinate and angle display
+- Golden T10/T6/T4 enchant display
+- Block AOTD ability
+- Block Livid Dagger ability
+- Disable Spirit Sceptre messages
+- Disable Midas Staff messages
+- Disable heal messages
+- Slayer item tracker
+- RNGesus drop alerts
+- Click anywhere on-screen to open Maddox
+- Maddox menu keybind
- Block starting other slayer quests
-- Fishing tracker (with graphic display) (scalable)
+- Fishing, jerry fishing, fishing festival, spooky fishing trackers
- Expertise kills in fishing rod lore
-- Dungeons tracker (with graphic display) (scalable)
-- Dungeons puzzle solver (Riddle, trivia, blaze, creeper) (toggleable)
-- Find correct Livid (with graphic display of HP) (toggleable)
+- Catacombs trackers
+- Dungeons puzzle solver (Riddle, trivia, blaze, creeper, water)
+- Find correct Livid (with graphic display of HP)
- Pet background colors based on level
-- Golem spawning alerts (toggleable)
+- Golem spawning alerts
+- Skill xp/hour tracker
- Show total skill xp instead of progress to next level
+- Show time until century cakes run out
+- Mythological event (Diana) tracker
+- Low health alert in dungeons
- API commands
- Update checker
## Commands
- /dhelp - Returns this message in-game.
- /dsm - Opens the GUI for Danker's Skyblock Mod.
-- /toggle <gparty/coords/golden/slayercount/rngesusalerts/splitfishing/chatmaddox/spiritbearalerts/aotd/sceptremessages/petcolors/dungeontimer/golemalerts/expertiselore/skill50display/outlinetext/lividsolver/oruopuzzle/blazepuzzle/creeperpuzzle/list> - Toggles features. /toggle list returns values of every toggle.
+- /toggle <gparty/coords/golden/slayercount/rngesusalerts/splitfishing/chatmaddox/spiritbearalerts/aotd/sceptremessages/petcolors/dungeontimer/golemalerts/expertiselore/skill50display/outlinetext/midasstaffmessages/healmessages/caketimer/lividsolver/lowhealthnotify/oruopuzzle/blazepuzzle/creeperpuzzle/waterpuzzle/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> [winter/f(1-6)/session] - Returns loot received from slayer quests or fishing stats. /loot fishing winter returns winter sea creatures instead.
-- /display <zombie/spider/wolf/fishing/catacombs/auto/off> [winter/f(1-6)/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.
+- /loot <zombie/spider/wolf/fishing/catacombs> [winter/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/auto/off> [winter/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/confirm/cancel> - - Resets loot for trackers. /resetloot confirm confirms the reset.
-- /move <coords/display/dungeontimer/skill50/lividhp> <x> <y> - Moves text display to specified X and Y coordinates.
-- /scale <coords/display/dungeontimer/skill50/lividhp> <scale (0.1 - 10)> - Scales text display to a specified multipler between 0.1x and 10x.
+- /move <coords/display/dungeontimer/skill50/lividhp/caketimer/skilltracker> <x> <y> - Moves text display to specified X and Y coordinates.
+- /scale <coords/display/dungeontimer/skill50/lividhp/caketimer/skilltracker> <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.
- /lobbyskills - Uses API to find the average skills of the lobby, as well the three players with the highest skill average.
@@ -53,12 +59,24 @@ Discord Server: https://discord.gg/QsEkNQS
- /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> <1/2/3/4> - Stops you from starting a slayer quest other than the one specified.
+- /skilltracker <start/stop/reset> - Text display for skill xp/hour.
## Keybinds
- Open Maddox menu - M by default.
+- Start/Stop Skill Tracker - Numpad 5 by default.
### 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).
+
+### Credits to Open Source Software
+Credit to all the following open source software used in this mod.
+
+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/) | No License
+[NotEnoughUpdates](https://github.com/Moulberry/NotEnoughUpdates/) | [Creative Commons Public License](https://github.com/Moulberry/NotEnoughUpdates/blob/master/LICENSE)
+[ForgeHax](https://github.com/fr1kin/ForgeHax) | [MIT License](https://github.com/fr1kin/ForgeHax/blob/1.16/LICENSE) \ No newline at end of file