Skip to content

jmakhack/hydrate-reminder

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!