hydrate-reminder: A Java repository from Lumary2

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!

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.

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

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

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 ⚠️ 🚧 📖 💻	_sosnovska ⚠️ 💻	_Dependabot 🚧	_{All Contributors} 📖	_{Emmanuel Olofintuyi} 📖
_{LOUKHNATI Mohamed Khalil} 💻 ⚠️	_{Neil Rush} 💻 ⚠️	_{Paul Ritzman} 💻 ⚠️	_roymw09 💻	_dcechano 💻
_NeboCode 💻	_{Harini Pa} 💻 ⚠️	_{Lior Bitton} 🚧 💻 📖	_{goncalo-machado} ⚠️	_{Nitu Vlad} 💻
_{TrevorJames95} 💻	_Kh1ng 💻	_Diemarg 💻 ⚠️	_{Marcin Słowiak} 💻 ⚠️ 🚧	_{Krish Pandya} 💻 📖
_{Finn Frölich} 💻 🚧	_{Soham Basu} 💻 ⚠️	_{Alexandru Mihalache} 💻	_{Maciej Słowiak} 💻 ⚠️ 📖	_Jacoberson 💻
_{Aakash Tyagi} 💻	_Kaushik-Iyer 🚧	_{Zainab Lawal} 💻	_{Harikesh Pallantla} 💻 ⚠️