Coder Social home page Coder Social logo

yapt's Introduction

yapt

Yet another pomodoro tool.

overview

A simple pomodoro tool as simple as a bash script. My initial intention was to use something like: https://github.com/gingivitis/i3-pomodoro, but I was discouraged due to nodejs. So, I decided to write a script that just uses shell and has no other requirements.

features

  • toggle
  • reset
  • tick sound (optional)
  • desktop notifications (optional)
  • i3 integration (optional)

This has been tested on linux and it works fine. It may or may not require additional tuning for other operating systems.

usage

To simply start a timer:

yapt

To toggle the timer (activate/deactivate):

yapt -t

To rest the timer:

yapt -r

To mute/unmute the tick sound:

yapt -m 

i3 integration

Just copy the the i3yapt from bin/i3yapt to your path and add the following lines, in your i3blocks.conf:

  [yapt]
  command=yapt
  signal=2
  interval=1

Actions:

  • Left click: Activate/Deactivate count down (pause/resume).
  • Middle click: Reset the timer.
  • Right click: Mute unmute the tick sound.

desktop notifications

If notify-send is found in the path, it will be used to send out a notification upon completion of the pomodoro. You can then configure you notification daemon, on how to handle the event. Below is an example of how to configure dunst, so that it plays a sound.

[pomodoro_completed]
summary = "Pomodoro Completed"
script = mplayer /usr/local/share/sounds/completion.wav > /dev/null

Note: The /usr/local/share/sounds/completion.wav is imaginary. You should point it to where you've stored the wav file that indicates completion.

yapt's People

Contributors

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