GithubHelp home page GithubHelp logo

kat-kan / hydrate-reminder Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jmakhack/hydrate-reminder

0.0 0.0 0.0 415 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 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!

hydrate-reminder's People

Contributors

jmakhack avatar allcontributors[bot] avatar dependabot[bot] avatar mslowiak avatar jacoberson avatar macslowiak avatar paulritzman avatar aakash232 avatar akshatjainei avatar harikesh409 avatar hpa16 avatar medkhabt avatar liorbitton avatar sohamangoes avatar akshu-on-github avatar alexmihalache99 avatar lumary2 avatar diemarg avatar xomute avatar finnpixel avatar ginglis13 avatar isurumaldeniya avatar kaushik-iyer avatar kh1ng avatar krishpandya682 avatar manish-singh-bisht avatar nebocode avatar neilrush avatar vlad-nitu avatar sanmay321 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.