jmakhack / hydrate-reminder

RuneLite plugin that sends reminders to take occasional hydration breaks.

Home Page:https://runelite.net/plugin-hub/show/hydrate-reminder

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Codacy grade


Adventurers, it is always of critical importantance to keep hydrated.
Never forget to drink water while exploring the world of Old School RuneScape ever again!

hydrate_water_dance

Any questions, comments, and/or feedback? Fill out the feedback form.

Plugin Features (v1.1.1)

Get a friendly reminder every x minutes to take a quick hydration break.

hydrate_reminders


Configure a variety of hydrate reminder settings such as:

  • Welcome message

    • Enable/Disable
  • Hydrate reminder interval length

    • Between 1 - 90 minutes
  • Notification types

    • Chat message notification

      • Game message notification
      • Broadcast message notification
      • Public chat notification
      • Clan chat notification
    • Computer tray notification

Screen Shot 2021-07-19 at 7 46 18 PM


Use a variety of optional builtin chat commands to enhance the hydrate reminder experience:

  • ::hr help

    • Displays the list of available commands
  • ::hr next

    • Displays the amount of time until the next hydrate reminder
  • ::hr prev

    • Displays the amount of time since the previous hydrate reminder
  • ::hr reset

    • Resets the current hydrate reminder interval
  • ::hr hydrate

    • Resets the current hydrate reminder interval and increase hydration breaks
  • ::hr total

    • Displays the number of hydration breaks taken

Screen Shot 2021-07-19 at 9 20 09 PM

Installation Instructions

This plugin is designed for use within the open source RuneLite OSRS client which is free to download.

To install the plugin, start up the RuneLite client and search for the Hydrate Reminder plugin in the Plugin Hub.
Detailed instructions on how to achieve this can be found on the RuneLite wiki.

Contributing

Anyone is welcome to contribute to this project repository in any capacity.
Before contributing to this project, please go through the How to Contribute guide to understand expectations for this project and for info on how to properly setup and build the project.

Other useful resources include the RuneLite wiki and OSRSBox's Writing RuneLite Plugins blog post.
It is recommended to use the IntelliJ IDEA development environment for this project.

To contribute any ideas, bug reports, and feedback, submit an issue or fill out the feedback form.

Code of Conduct

Hydrate Reminder is governed by the Contributor Covenant v1.4.

License

Hydrate Reminder is licensed under the BSD-2-Clause License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

jmakhack
jmakhack

⚠️ 🚧 📖 💻
sosnovska
sosnovska

⚠️ 💻
Dependabot
Dependabot

🚧
All Contributors
All Contributors

📖
Emmanuel Olofintuyi
Emmanuel Olofintuyi

📖
LOUKHNATI Mohamed Khalil
LOUKHNATI Mohamed Khalil

💻 ⚠️
Neil Rush
Neil Rush

💻 ⚠️
Paul Ritzman
Paul Ritzman

💻 ⚠️
roymw09
roymw09

💻
dcechano
dcechano

💻
NeboCode
NeboCode

💻
Harini Pa
Harini Pa

💻 ⚠️
Lior Bitton
Lior Bitton

🚧 💻 📖
goncalo-machado
goncalo-machado

⚠️
Nitu Vlad
Nitu Vlad

💻
TrevorJames95
TrevorJames95

💻
Kh1ng
Kh1ng

💻
Diemarg
Diemarg

💻 ⚠️
Marcin Słowiak
Marcin Słowiak

💻 ⚠️ 🚧
Krish Pandya
Krish Pandya

💻 📖
Finn Frölich
Finn Frölich

💻 🚧
Soham Basu
Soham Basu

💻 ⚠️
Alexandru Mihalache
Alexandru Mihalache

💻
Maciej Słowiak
Maciej Słowiak

💻 ⚠️ 📖
Jacoberson
Jacoberson

💻 ⚠️
Aakash Tyagi
Aakash Tyagi

💻
Kaushik-Iyer
Kaushik-Iyer

🚧
Zainab Lawal
Zainab Lawal

💻
Harikesh Pallantla
Harikesh Pallantla

💻 ⚠️
Anja Bender
Anja Bender

💻
utsav82
utsav82

💻
Akshat Jain
Akshat Jain

💻
Swati Chauhan
Swati Chauhan

💻
Sanmay Das
Sanmay Das

💻
Gavin Inglis
Gavin Inglis

💻
jivjen
jivjen

💻
Dmytro Khomutnyk
Dmytro Khomutnyk

💻
Isuru Maldeniya
Isuru Maldeniya

💻
Manish Singh Bisht
Manish Singh Bisht

💻
Akshaya Kulasekaran
Akshaya Kulasekaran

💻
nn
nn

💻
Katarzyna
Katarzyna

💻
AbbasSalloum
AbbasSalloum

⚠️
Vicky Aryan
Vicky Aryan

💻
mohitkumaragrawal
mohitkumaragrawal

📖
A. Singh
A. Singh

💻
G0R1LL4
G0R1LL4

💻
Akshat Rawat
Akshat Rawat

💻
Vikash
Vikash

💻
jhonDoe15
jhonDoe15

💻
spacecowboy
spacecowboy

📖
Ron Huberfeld
Ron Huberfeld

💻
Mohd Arsh Ali
Mohd Arsh Ali

💻
Sanjeev Bengeri
Sanjeev Bengeri

⚠️
AstroITNinja
AstroITNinja

💻
Aravind
Aravind

💻 ⚠️
Davide Donadio
Davide Donadio

⚠️
Prajwal Rayal
Prajwal Rayal

💻 ⚠️
Mrinalini Upadhya
Mrinalini Upadhya

📖
PetraJankurova
PetraJankurova

💻
Danish Ayub Khan
Danish Ayub Khan

⚠️
Sid
Sid

💻

This project follows the all-contributors specification. Contributions of any kind welcome!