Hydrate Reminder

<p align="center">

<img src="https://i.imgur.com/bztOLOO.png" />

</p>

<p align="center">

<a href="https://github.com/jmakhack/hydrate-reminder/actions?query=workflow%3A%22Java+CI+with+Gradle%22" alt="Build Status">

<img src="https://img.shields.io/github/workflow/status/jmakhack/hydrate-reminder/Java%20CI%20with%20Gradle?style=for-the-badge" />

</a>

<a href="https://www.codacy.com/gh/jmakhack/hydrate-reminder/dashboard" alt="Code Quality">

<img alt="Codacy grade" src="https://img.shields.io/codacy/grade/acefd6d303a24a76b1aac55026a51398?style=for-the-badge">

</a>

<a href="#" alt="Repo Size">

<img src="https://img.shields.io/github/repo-size/jmakhack/hydrate-reminder?style=for-the-badge" />

</a>

<a href="https://github.com/jmakhack/hydrate-reminder/issues" alt="Open Issues">

<img src="https://img.shields.io/github/issues/jmakhack/hydrate-reminder?style=for-the-badge" />

</a>

<a href="https://github.com/jmakhack/hydrate-reminder/blob/master/LICENSE" alt="License">

<img src="https://img.shields.io/github/license/jmakhack/hydrate-reminder?style=for-the-badge" />

</a>

<a href="https://github.com/jmakhack/hydrate-reminder/releases" alt="Version">

<img src="https://img.shields.io/github/v/release/jmakhack/hydrate-reminder?style=for-the-badge" />

</a>

<a href="https://github.com/jmakhack/hydrate-reminder/releases" alt="Release Date">

<img src="https://img.shields.io/github/release-date/jmakhack/hydrate-reminder?style=for-the-badge" />

</a>

<a href="#contributors-" alt="All Contributors">

<img src="https://img.shields.io/github/all-contributors/jmakhack/hydrate-reminder?style=for-the-badge" />

</a>

<a href="https://matias.ma/nsfw/" alt="Made With Love">

<img src="https://img.shields.io/badge/Made%20With%20Love-(%E2%97%8F%E2%99%A1%E2%88%80%E2%99%A1))%E3%83%BE%E2%98%86*%E3%80%82-blueviolet?style=for-the-badge" />

</a>

</p>

<br/>

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

Plugin Features (v1.1.1)

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

!hydrate_reminders

<hr/>

Configure a variety of hydrate reminder settings such as:

• Welcome message

- Enable/Disable

• Hydrate reminder interval length

- Between 1 - 120 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

<hr/>

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

!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.

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

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore-start -->

<!-- markdownlint-disable -->

<table>

<tr>

<td align="center"><a href="https://github.com/jmakhack"><img src="https://avatars.githubusercontent.com/u/1442227?v=4?s=100" width="100px;" alt=""/><br />_{<b>jmakhack</b>}</a><br /><a href="https://github.com/jmakhack/hydrate-reminder/commits?author=jmakhack" title="Tests">⚠️</a> <a href="#maintenance-jmakhack" title="Maintenance">🚧</a> <a href="https://github.com/jmakhack/hydrate-reminder/commits?author=jmakhack" title="Documentation">📖</a> <a href="https://github.com/jmakhack/hydrate-reminder/commits?author=jmakhack" title="Code">💻</a></td>

<td align="center"><a href="https://github.com/sosnovska"><img src="https://avatars.githubusercontent.com/u/11365065?v=4?s=100" width="100px;" alt=""/><br />_{<b>sosnovska</b>}</a><br /><a href="https://github.com/jmakhack/hydrate-reminder/commits?author=sosnovska" title="Tests">⚠️</a> <a href="https://github.com/jmakhack/hydrate-reminder/commits?author=sosnovska" title="Code">💻</a></td>

<td align="center"><a href="https://github.com/features/security"><img src="https://avatars.githubusercontent.com/u/27347476?v=4?s=100" width="100px;" alt=""/><br />_{<b>Dependabot</b>}</a><br /><a href="#maintenance-dependabot" title="Maintenance">🚧</a></td>

<td align="center"><a href="https://allcontributors.org"><img src="https://avatars.githubusercontent.com/u/46410174?v=4?s=100" width="100px;" alt=""/><br />_{<b>All Contributors</b>}</a><br /><a href="https://github.com/jmakhack/hydrate-reminder/commits?author=all-contributors" title="Documentation">📖</a></td>

<td align="center"><a href="https://github.com/EmmanuelOlofintuyi"><img src="https://avatars.githubusercontent.com/u/46730204?v=4?s=100" width="100px;" alt=""/><br />_{<b>Emmanuel Olofintuyi</b>}</a><br /><a href="https://github.com/jmakhack/hydrate-reminder/commits?author=EmmanuelOlofintuyi" title="Documentation">📖</a></td>

<td align="center"><a href="https://github.com/medkhabt"><img src="https://avatars.githubusercontent.com/u/34715586?v=4?s=100" width="100px;" alt=""/><br />_{<b>LOUKHNATI Mohamed Khalil</b>}</a><br /><a href="https://github.com/jmakhack/hydrate-reminder/commits?author=medkhabt" title="Code">💻</a> <a href="https://github.com/jmakhack/hydrate-reminder/commits?author=medkhabt" title="Tests">⚠️</a></td>

<td align="center"><a href="https://github.com/neilrush"><img src="https://avatars.githubusercontent.com/u/31221793?v=4?s=100" width="100px;" alt=""/><br />_{<b>Neil Rush</b>}</a><br /><a href="https://github.com/jmakhack/hydrate-reminder/commits?author=neilrush" title="Code">💻</a> <a href="https://github.com/jmakhack/hydrate-reminder/commits?author=neilrush" title="Tests">⚠️</a></td>

</tr>

</table>

<!-- markdownlint-restore -->

<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

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