Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/opendevs-org/relax-a-little

this extension makes you relax while coding
https://github.com/opendevs-org/relax-a-little

developer drink-water extension health interval javascript marketplace reminder tools vscode

Last synced: about 2 months ago
JSON representation

this extension makes you relax while coding

Awesome Lists containing this project

README

        

# relax a little ☕

## write code 👨‍💻 while staying healthy 💪

![Version](https://img.shields.io/badge/version-0.3.2-blue.svg?cacheSeconds=2592000)
![Prerequisite](https://img.shields.io/badge/vscode-%5E1.52.0-blue.svg)
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/open-devs/relax-a-little#readme)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/open-devs/relax-a-little/graphs/commit-activity)
[![Twitter: opendevs\_2020](https://img.shields.io/twitter/follow/opendevs\_2020.svg?style=social)](https://twitter.com/opendevs\_2020)
![relax-a-little](https://github.com/open-devs/relax-a-little/workflows/relax-a-little/badge.svg)

> this extension provides tools to relax like giving reminders to look somewhere else, drink water, walk, do some lunges or best of all, slowly fades out the colors until you take your hands off the keyboard for a moment. comes with lot of configurations to control time of reminder, interval, water drinking intervals, generic break alert and more

**🔴 WARNING! this plugin will overwrite `workbench.colorCustomizations` and `editor.tokenColorCustomizations`.**

## 🙌 support us

**save money on medications instead give a ⭐️ if this project helped you &**

Buy Me A Coffee

## 🏠 [homepage](https://github.com/open-devs/relax-a-little)

## ✨ demo

### winddown feature

![winddown feature](https://raw.githubusercontent.com/open-devs/relax-a-little/main/static/images/demo.gif)

### water break feature

in status bar:

![water break feature](https://raw.githubusercontent.com/open-devs/relax-a-little/main/static/images/water-break.png)

## prerequisites

- vscode ^1.52.0

## installation

[install relax-a-little from the vs code marketplace](https://marketplace.visualstudio.com/items?itemName=open-devs.relax-a-little)

## ⚡ available configurations

| configuration | description |
| ----------------------------------------------| ----------------------------------------------------- |
| relax.minutesTillBreak | time in minutes until theme colors start fading out. |
| relax.winddownDurationMinutes | time in minutes until theme colors have fully faded out. |
| relax.breakDurationMinutes | time in minutes until theme colors are reset to normal. |
| relax.winddownFramesPerMinute | color update frequency during winddown phase. usually you do not need to change this. lower it if you are distracted by screen flashes, increase it for smoother color transitions. Must be between 1 and 60. |
| relax.minutesTillWaterBreak | time in minutes until water break. (feature will be disabled if set to 0) |
| relax.minutesTillGenericBreak | time in minutes after which extension will ask to take break (feature will be disabled if set to 0, disables winddown if active). |
| relax.enableBlockingNotification | do you want blocking notifications from time to time? Turn this off if you prefer text in bottom bar only. |

## ⚡ available commands

| command | description |
| ----------------------------------------------| ----------------------------------------------------- |
| relax.enableExtension | enable extension. |
| relax.disableExtension | disable extension. |
| relax.enableWinddown | enable winddown. |
| relax.disableWinddown | disable winddown. |
| relax.enableWaterBreak | enable water break. |
| relax.disableWaterBreak | disable water break. |
| relax.enableGenericBreakAlert | enable generic break (alerts only without color change) alert. |
| relax.disableGenericBreakAlert | disable generic break (alerts only without color change) alert. |

## development

- `npm install` or `yarn`
- in vs code, "Run", "Start debugging" or press `F5`

## Publishing

- `npm run build`
- `vsce package`
- upload package to marketplace

## Related Projects

- inspired by Android's [Digital Wellbeing](https://www.android.com/digital-wellbeing/)
- [emacs-winddown](https://github.com/syohex/emacs-winddown)
- [atheos-winddown](https://github.com/HLSiira/Atheos-Winddown)
- [vscode-winddown](https://github.com/schneefux/vscode-winddown)

## Author

👤 **open devs**

- Website: https://opendevs.in/
- Twitter: [@opendevs_2020](https://twitter.com/@opendevs_2020)
- Github: [@open-devs](https://github.com/open-devs)
- LinkedIn: [@open-devs](https://www.linkedin.com/company/open-devs/)
- core members: [@mikr13](https://github.com/mikr13), [@alok722](https://github.com/alok722)

## 🤝 contributing

contributions, issues and feature requests are welcome!

feel free to check [issues page](https://github.com/open-devs/relax-a-little/issues). you can also take a look at the [contributing guide](https://github.com/open-devs/relax-a-little/blob/master/CONTRIBUTING.md).

## 📝 license

copyright © 2021 [open devs](https://github.com/open-devs).

this project is [MIT](https://github.com/open-devs/relax-a-little/blob/master/LICENSE) licensed.

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_