Giter Site home page Giter Site logo

betterbuffsbar's Introduction

Better Buff Bar

Track only the buffs that actually matter.

"This is what I'd like our buff bar to be." - Mod Sponge

Better Buffs Bar - BuffsBetter Buffs Bar - Settings

How to Install & Required Settings

To install Better Buff Bar copy & paste this link into Alt1's browser app: alt1://addapp/https://nadyanayme.github.io/BetterBuffsBar/dist/appconfig.json

If you do not have Alt1 Toolkit installed already you can download it from runeapps.org. In order for Better Buff Bar to work make sure your Runescape settings for buff bar size is set to small and that your Game and UI Scale settings are set to 100% as these settings are required for Alt1 to be able to read your game screen.

Currently only works with Small Buff icons. Alt1's BuffReader only works with small buff icons so this is unlikely to change soon.

  • Drag & drop buffs into desired display order (to be sorted properly the 'Fade Inactive Buffs' setting must be toggled on)
  • Select number of buffs that should appear in each row
  • Decide whether buffs should disappear or turn grayscale when inactive
  • Set Overlay Position
  • Enable Overlay

Features

  • Track important buffs (if it isn't listed it wasn't important enough - but more seriously DM me @ NadyaNayme on Discord if you'd like to add a buff to be tracked)
  • Select order that buffs should be displayed and which should be tracked. Faded buffs must first be enabled to sort them.
  • Choose between fading the buff out when inactive or hiding it from the better buff bar.
  • "Big Head Mode" to make the first buff x4 larger
  • 3s~ tooltip when Overloads expire
  • Blink "!!" over maintainable buffs that have expired (eg. Overloads, Weapon Poison, Darkness, Animate Dead)

Tracked Buffs

  • Overloads & Elder Overloads (sorry Supreme Ovl. users)
  • Weapon Poison
  • Darkness
  • Animate Dead
  • Gladiator's Rage (Ful Book Proc)
  • Time Rift (Jas Book Proc)
  • BOLG Stacks / Spec
  • FSOA Spec
  • Death Guard Spec cooldown
  • Omni Guard Spec cooldown
  • Seren Godbow spec cooldown
  • Enhanced Excalibur cooldown
  • Ancient Elven Ritual Shard cooldown
  • Adrenaline Potion cooldown
  • Necrosis stacks
  • Berserk cooldown *
  • (Greater) Sunshine cooldown *
  • (Greater) Death's Swiftness cooldown *
  • Living Dead cooldown *
  • Limitless *
  • Undead Slayer Ability *
  • Dragon Slayer Ability *
  • Demon Slayer Ability *
  • Ingenuity of the Humans *
  • Overhead Prayers
  • DPS Prayers
  • Active Aura time remaining
  • Bonfire Boost
  • Erethdor's Grimoire (active status)
  • Lantadyme Incense Sticks
  • Kwuarm Incense Sticks
  • Dwarf Weed Incense Sticks
  • Fellstalk Incense Sticks
  • Stunned
  • Anticipation
  • Barricade
  • Devotiion
  • Divert
  • Freedom
  • Immortality
  • Reflect
  • Resonance
  • Death Spark
  • Vulnerability Bomb
  • Death Mark

* An attempt is made to track cooldowns. It can drift and become inaccurate when the server drops ticks/lags. Outside of DXPW on very laggy worlds it typically shouldn't be off by more than a second or two.

Known Issues

  • Overloads with <10s remaining can't be tracked due to the buff fading in and out. Ask a Jmod to please stop expiring buffs from doing that. Alt 1 can't track them properly. :)
  • BOLG stacks split into Time + Stack buffs will occasionally report Time as Stacks until a Stack is gained if you use the Weapon Special while already under the effects of the Weapon Special. It fixes itself when you gain at least one stack again.

If you encounter any other bugs - please submit an issue and I'll investigate it.

My Other Plugins

To see my other Alt1 plugins click here

betterbuffsbar's People

Contributors

filipagh avatar nadyanayme avatar whitfin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

betterbuffsbar's Issues

Living Death cooldown icon persists

The icon for Living Death's cooldown persists, meaning if never disappears and stays at 2 seconds despite "Fade Inactive Buffs" being disabled. I tried multiple times.

it's obviously not a big issue, but I do like a clean UI

Runeapps Alt1_3NDdO2FLR7

Want to contribute? Here's how to add buffs/debuffs to be tracked!

Step 1) Get the icon from RS Wiki. Ideally it doesn't have text or a background - if it does you'll want to use image editing software to clean it up as best as you can. Don't use tools like remove.bg because the process needs to be as exact as possible. I recommend photopea.com if you don't have good image editing software installed. Save the icon as is to /asset/resource/ as buff.png. If this is a debuff that is meant to track cooldown (eg. weapon specs) change the border color from "debuff red" (#cc0000) to "buff green" (#5a9619).

Step 2) Create a desaturated (set saturation to 0 and darken the image slightly) version of the buff. On Photopea I use 0 saturation and -25 lightness. Check for any black (#000000) pixels and change them to #010101 as the overlay will render #000000 as transparent otherwise. Save the image to /asset/resource/ as buff-desat.png

Step 3) Crop the buff/debuff border out of the image and save the image to /asset/data/ as buff.data.png

Step 4) Add the buff to /src/index.html above the spacers but below the last existing buff/debuff. The ID should be the name of the buff/debuff, data-id should be incremented by 1, and the <span> for the buff name should be the name of the buff. if the buff is meant to have 100% uptime add the maintainable class. Look at existing buffs/debuffs as examples of what this should look like.

Step 5) Update /src/css/betterbuffsbar.css in a similar fashion to other buffs. You should be adding two selectors - one for your #BuffID and another for #BuffId.inactive. Set the background-image of #BuffID to the buff.png image and #BuffID.inactive to the buff-desat.png image. Look at existing buffs/debuffs as examples of what this should look like.

Step 5.5) You can send a PR at this point - as the most tedious part is now complete. If you would like to complete the remaining steps you can but it is not necessary for me to accept your PR.

Step 6) Update /src/index.ts adding your buff or debuff to buffsList and debuffsList in a similar fashion to existing buffs or debuffs.

Step 7) Update buffImages or debuffImages in a similar fashion to existing buffs or debuffs.

Step 8) Inside of watchBuffs() add a findStatus() for your buff in a similar fashion to existing buffs or debuffs. For transparent buffs/debuffs the threshold is usually around 60-80 but can be as low as 20 for opaque buffs/debuffs the threshold is usually 300+.

Note: RS Wiki icons are not always usable and may include backgrounds and text. While some may be possible to use for detection they cannot be displayed nicely in the buffs tracker and so will not be used unless a nice enough buff image is made. It's OK if it isn't absolutely perfect but it should be close.

Abilities can get "stuck" if a false positive triggers activity

This is probably specific to abilities with cooldowns - but if a false positive triggers it it gets placed active but a timer is never started because the timer never reaches the time when it should swap over to the cooldown state. Resulting in a buff that lasts indefinitely (or until it is detected for real).

Potential mitigation: set inactive if both cooldown and timer aren't being modified.

Suggestion: Sound alerts

Hello,

First of all, I want to thank you for the amazing work you did with this plugin. I just wonder if there are any plans to introduce sound alerts. Thank you in advance.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.