Kalakoi/gauntlet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Charles Xu
2019-07-29 21:09:50 -04:00
committed by GitHub
parent a89f6030c0
commit f61963d679
1 changed files with 67 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
README.md
View File

@@ -3,51 +3,89 @@
**Last Updated:** July 27, 2019
**Disclaimer:** I'm only 5 hours into this boss with 2 normal kc and 6 corrupted kc. More features will be added as they become relevant. You will need to compile the classes yourself if you want to use the project.
**Disclaimer:** You will need to compile the classes yourself if you want to use the project.
**License:** WTFPL (https://en.wikipedia.org/wiki/WTFPL) - Everyone is permitted to copy and distribute.
## Major Changelog:
```
July 27, 2019 - Initial Plugin Release
July 29, 2019 - Plugin Overhaul
+ All configurations have become independant. You can disable one without affecting the other.
+ Prayer audio no longer ignores sound settings
+ Prayer attack visual is now independant to Magic and Range attacks.
+ Magic and Range attacks now have their own visuals.
+ Boss attack style icon can be toggled.
+ Timer is now available.
+ Ability to change icon size
```
## Settings and Features:
![alt text](https://www.kthisiscvpv.com/jmeE91564311006SAwWl.png)
![alt text](https://www.kthisiscvpv.com/KyqTh1564447070mA2Yl.png)
## Highlight Resources:
## Highlight Resources (Color):
Resource deposits in each room will be highlighted in yellow.
![alt text](https://www.kthisiscvpv.com/BvhGO1564311286FFSvx.jpg)
## Highlight Resources (Icon):
Resource deposits in each room will have an icon specifying their individual types.
## Highlight Icons:
Resource deposits in each room will be highlighted in yellow.
**Warning:** This setting depends on __Highlight Resources__ being turned __ON__.
![alt text](https://www.kthisiscvpv.com/tYCOE1564311216ylXbk.png)
## Count Player Attacks:
Count the amount of player attacks left until the boss changes their prayer.
**Warning:** This setting depends on __Boss Attacks__ being turned __ON__.
![alt text](https://www.kthisiscvpv.com/AA7z61564447413LG9GI.png)
## Count Boss Attacks:
Count the amount of attacks left until the boss changes their attack style.
![alt text](https://www.kthisiscvpv.com/xCD8R1564311933UX6Fl.png)
## Count Player Attacks:
Count the amount of player attacks left until the boss changes their prayer.
## Show Attack Styles:
Overlays each projectile shot by the boss with an icon.
![alt text](https://www.kthisiscvpv.com/kCDGa1564447914IXMt7.png)
![alt text](https://www.kthisiscvpv.com/YlKVu1564312230N1WO2.png)
## Unique Prayer Audio:
Plays a unique sound whenever the boss is about to shut down your prayer.
## Overlay the Boss:
Overlay the boss entirely with a color coded style reference.
``client.playSoundEffect(SoundEffectID.MAGIC_SPLASH_BOING);``
![alt text](https://www.kthisiscvpv.com/oBZp01564312305iuqmm.png)
![alt text](https://www.kthisiscvpv.com/vJjSJ1564312314gMpm5.png)
![alt text](https://www.kthisiscvpv.com/T1hDw1564312358bZc3h.png)
![alt text](https://www.kthisiscvpv.com/mSw8X1564312347BshE3.png)
## Unique Prayer Visual:
Prayer attacks will have a unique overlay visual.
## Play Tune on Prayer Attack:
Play a quick tune when the prayer attack is being sent.
![alt text](https://www.kthisiscvpv.com/Irprn1564448139Vaxsp.png)
**Warning:** This setting will override your in-game sound settings.
## Unique Magic & Range Visuals:
Magic and Range attacks will have a unique overlay visual.
``client.playSoundEffect(SoundEffectID.MAGIC_SPLASH_BOING, SoundEffectVolume.MEDIUM_HIGH);``
![alt text](https://www.kthisiscvpv.com/Ws1yX1564448168Eympq.png)
## Overlay the Boss (Color):
Overlay the boss with an color denoting it's current attack style.
## Overlay the Boss (Icon):
Overlay the boss with an icon denoting it's current attack style.
![alt text](https://www.kthisiscvpv.com/QC2P91564447661A598x.png)
## Show Tornado Decay:
Display the amount of ticks left until the tornadoes decay.
![alt text](https://www.kthisiscvpv.com/H44wz1564448298tMMS5.png)
## Show Custom Timer (Widget):
Display a timer widget that tracks your gauntlet progress.
![alt text](https://www.kthisiscvpv.com/hZT4a1564448458EP5y4.png)
## Show Custom Timer (Chat):
Display a chat message that tracks your gauntlet progress.
```
Triggers:
... when the player dies or leaves the raid during preperation.
... when the player first enters the boss room.
... when the player dies during the boss fight.
```
![alt text](https://www.kthisiscvpv.com/uW8IY1564448575Sn5ze.png)
## Gloabl Icon Size:
Globally change the size of icons. { Range: 1 to 50 }
![alt text](https://www.kthisiscvpv.com/JQNN71564448951PRMGV.gif)