Skip to content

Latest commit

 

History

History
executable file
·
150 lines (118 loc) · 12.2 KB

README.md

File metadata and controls

executable file
·
150 lines (118 loc) · 12.2 KB

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 this 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:

  • ::hydrate help
    • Displays the list of available commands
  • ::hydrate next
    • Displays the amount of time until the next hydrate reminder
  • ::hydrate prev
    • Displays the amount of time since the previous hydrate reminder
  • ::hydrate reset
    • Resets the current hydrate reminder interval
  • ::hydrate 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.

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

💻 ⚠️

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