122 lines
3.6 KiB
Markdown
122 lines
3.6 KiB
Markdown
# RuneLite Gauntlet Plugin
|
|
**Author:** Yuri-chan (Nagi#0001)
|
|
|
|
**Last Updated:** April 17th 2020
|
|
|
|
This plugin has beeen deprecated. The official RuneLite has stopped supporting the "Projectiles" class, one of the fundamental classes of this project.
|
|
|
|
I recommend that you switch to OpenOSRS.
|
|
|
|
**OpenOSRS** -> https://openosrs.com/
|
|
|
|
**Plugin Fork** -> @xKylee https://github.com/xKylee/plugins-source
|
|
|
|
---
|
|
|
|
**Update:** February 10, 2020
|
|
|
|
**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:
|
|
```
|
|
February 10, 2020 - Version 1.3.1
|
|
- Removed hull highlighting from boss and projectiles (DEPRECATED)
|
|
|
|
July 30, 2019 - Version 1.3
|
|
+ Instance Map
|
|
|
|
July 29, 2019 - Version 1.2 "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
|
|
|
|
July 27, 2019 - Version 1.1 "Initial Plugin Release"
|
|
+ Boss Overlay
|
|
+ Boss & Player Counter
|
|
+ Resources Overlay
|
|
```
|
|
|
|
## Settings and Features:
|
|
|
|
|
|
# Version 1.3
|
|
|
|
## Show Map:
|
|
Show a live instance map as you travel around the map.
|
|
|
|
|
|
|
|
# Version 1.2
|
|
|
|
## Highlight Resources (Color):
|
|
Resource deposits in each room will be highlighted in yellow.
|
|
|
|
## Highlight Resources (Icon):
|
|
Resource deposits in each room will have an icon specifying their individual types.
|
|
|
|
|
|
|
|
## Count Boss Attacks:
|
|
Count the amount of attacks left until the boss changes their attack style.
|
|
|
|
## Count Player Attacks:
|
|
Count the amount of player attacks left until the boss changes their prayer.
|
|
|
|
|
|
|
|
## Unique Prayer Audio:
|
|
Plays a unique sound whenever the boss is about to shut down your prayer.
|
|
|
|
``client.playSoundEffect(SoundEffectID.MAGIC_SPLASH_BOING);``
|
|
|
|
## Unique Prayer Visual:
|
|
Prayer attacks will have a unique overlay visual.
|
|
|
|
|
|
|
|
## Unique Magic & Range Visuals:
|
|
Magic and Range attacks will have a unique overlay visual. (REMOVED - DEPRECATED)
|
|
|
|
|
|
|
|
## Overlay the Boss (Color):
|
|
Overlay the boss with an color denoting it's current attack style. (REMOVED - DEPRECATED)
|
|
|
|
## Overlay the Boss (Icon):
|
|
Overlay the boss with an icon denoting it's current attack style.
|
|
|
|
|
|
|
|
## Show Tornado Decay:
|
|
Display the amount of ticks left until the tornadoes decay.
|
|
|
|
|
|
|
|
## Show Custom Timer (Widget):
|
|
Display a timer widget that tracks your gauntlet progress.
|
|
|
|
|
|
|
|
## 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.
|
|
```
|
|
|
|
|
|
|
|
## Gloabl Icon Size:
|
|
Globally change the size of icons. { Range: 1 to 50 }
|
|
|
|
|