Giter Site home page Giter Site logo

krishpandya682 / hydrate-reminder Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jmakhack/hydrate-reminder

0.0 1.0 0.0 270 KB

RuneLite plugin that sends reminders to take occasional hydration breaks.

Home Page: https://runelite.net/plugin-hub/show/hydrate-reminder

License: BSD 2-Clause "Simplified" License

Java 100.00%

hydrate-reminder's Introduction

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

💻 ⚠️

Marcin Słowiak

💻 ⚠️ 🚧

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

hydrate-reminder's People

Contributors

jmakhack avatar allcontributors[bot] avatar dependabot[bot] avatar mslowiak avatar paulritzman avatar hpa16 avatar medkhabt avatar liorbitton avatar diemarg avatar kh1ng avatar nebocode avatar neilrush avatar vlad-nitu avatar trevorjames95 avatar dcechano avatar goncalo-machado avatar roymw09 avatar sosnovska avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.