Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/HACKER097/wisdom-tree

Wisdom Tree is a TUI concentration app, with features like pomodoro timer, YouTube music player, Lo-fi radio.
https://github.com/HACKER097/wisdom-tree

cli concentration music pomodoro pomodoro-technique pomodoro-timer python tui youtube

Last synced: 1 day ago
JSON representation

Wisdom Tree is a TUI concentration app, with features like pomodoro timer, YouTube music player, Lo-fi radio.

Awesome Lists containing this project

README

        


wisdom-tree
Wisdom Tree

[![Downloads](https://pepy.tech/badge/wisdom-tree)](https://pepy.tech/project/wisdom-tree)
[![Downloads](https://pepy.tech/badge/wisdom-tree/month)](https://pepy.tech/project/wisdom-tree)
[![Downloads](https://pepy.tech/badge/wisdom-tree/week)](https://pepy.tech/project/wisdom-tree)

Wisdom Tree is a tui concentration app. Inspired by the wisdom tree in Plants vs. Zombies which gives in-game tips when it grows, Wisdom Tree gives you real life tips when it grows. How can you grow the tree? by concentrating!

# Showcase
https://user-images.githubusercontent.com/38581702/235925233-1abe0e76-da53-41a7-9219-48686aab879c.mp4

# Screenshots
![alt text](https://imgur.com/nFw46EN.png)
![alt text](https://imgur.com/Q1rGccM.png)
![alt text](https://imgur.com/VvRaLYd.png)
![alt text](https://imgur.com/MJCkdMb.png)

# Installation

Wisdom-tree uses vlc to play music, please make sure vlc is installed.

Extra step for mac `brew install sdl2_mixer`

Extra step for Windows `pip install windows-curses` or `pipx inject wisdom-tree windows-curses`

## Installation from PyPi
`pip install wisdom-tree` or `pip3 install wisdom-tree`

## Installation using [pipx](https://pypa.github.io/pipx/)
`pipx install wisdom-tree`

This allows you to run the app from anywhere

## Installation From Github
`git clone https://github.com/HACKER097/wisdom-tree`

`cd wisdom-tree`

`pip install -r requirements.txt`
or
`pip3 install -r requirements.txt`

## Running the app

- From anywhere after installation from PyPi or using pipx

`wisdom-tree`

- From the github repository (root):

`python3 wisdom_tree/main.py`

*note the underscore*

or

`wisdom-tree`

# Usage

Use `left` and `right` arrow keys to change music

To add your own music, place it inside the `res/` directory (all music must be in `.ogg` format)

Use `up` an `down` arrow keys an `enter` to select and start Pomodoro timers.

While using lofi-radio use `n` to skip song and `r` to replay

`[` and `]` to increase and decrease the music/ambience volume respectively

`{` and `}` to increase and decrease the sound effect volume respectively

*You can replace arrow keys with vim's navigation keys (hjkl)*

`m` to mute music.

`r` to toggle repeat.

`u` to toggle q[u]iet mode, which mutes growth sounds and timer start sounds.

`space` to pause and unpause.

`+`, `-` to seek 10 sec forwards and backwords

number keys `0-9` to go 0-90% into the audio. Eg; pressing 6 will take you 60% into the audio, 7 will take you 70% and so on.

To exit press `q`

## Custom quotes

The user can use any set of quotes by adding a file called `qts.txt` with
one qoute per line to the default config location:

{`CONFIG_LOCATION`}/wisdom-tree

where {`CONFIG_LOCATION`} is the default place to save configuration files
for the operating system:

- windows: The folder pointed to by `LOCALAPPDATA` or `APPDATA`
- mac/linux: The folder pointed to by `XDG_CONFIG_HOME` or `~/.config`

*for now, adding a custom quotes file disables the default quotes*

# Features

Wisdom tree plays a variety of music, environmental sounds and white noises to help you concentrate. You can also import your own music into Wisdom Tree.

3000+ quotes and lines of wisdom. You are assured that you will never see the same quote again

Minimal interface and navigation to increase concentration.

Pomodoro timer

Play music from youtube

Lo-Fi radio

# Upcoming Features

~~Play music from youtube~~

~~Lo-Fi radio~~

If you would like to see a feature implemented, please open an issue with tag [FEATURE REQUEST]

# Tipping

Before you consider donating, please note that I am still a school student and code in my free time, donating **will not** help me work on wisdom-tree or my other projects faster. Your tip can end up on onlycoins at worst, or pay for my college tuition at best.

Monero:-

`42hk7SW7mdM5JXYRLAaiD47bqchNGfXJ8aQGhuQJuF9cTBhC5w94aUEcxt7NfokV2URy78RgSXdbiUGYCQZsPFjqDfi7Lto`