From 36a30bd1a2097b6ab45c27bd248cbea4e292499f Mon Sep 17 00:00:00 2001 From: bowser0000 Date: Thu, 28 Apr 2022 22:18:02 -0400 Subject: Make README cleaner From #111 --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2af7339..2a316a0 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 +
+Incompatibilites + ## 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 +
+ +
+Current Features -## Current features +## Current Features - Guild party desktop notifications - Coordinate and angle display - Golden T10/T6/T4 enchant display @@ -67,6 +74,10 @@ Discord Server: https://discord.gg/QsEkNQS - Automatically join skyblock - Fire pillar display - Chat aliases +
+ +
+Commands ## Commands - /dhelp - Returns this message in-game. @@ -101,11 +112,19 @@ Discord Server: https://discord.gg/QsEkNQS - /reloaddsmrepo - Reloads Danker's Skyblock Mod repository. - /dsmfarmlength - 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. +
+ +
+Keybinds ## Keybinds - Open Maddox menu - M by default. - Regular Ability - Numpad 4 by default. - Start/Stop Skill Tracker - Numpad 5 by default. +
+ +
+Custom Music ## Custom Music 1. Place a music file with the given name in the `.minecraft/config/dsmmusic` folder: @@ -138,6 +157,10 @@ By adding numbers to the end of the file, you can have multiple music files for - dungeon1.wav - dungeon2.wav - dungeon99.wav +
+ +
+Alert Regex ## 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. @@ -151,13 +174,17 @@ Trigger Message: `From [ADMIN] Plancke: Nice autogg` the following alert text would appear `Plancke says Nice autogg`. +
+
+Notes ### 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. -- cgit