Skip to content

kat-kan/hydrate-reminder

ย 
ย 

Repository files navigation


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 or join the Discord.

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. Also join the Discord to ask any questions and engage with other project contributors.

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

๐Ÿ’ป

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

About

RuneLite plugin that sends reminders to take occasional hydration breaks.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%