OrgGo/gomu
1
0
Fork 0
mirror of https://github.com/issadarkthing/gomu.git synced 2025-04-28 13:48:53 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3 from kristerj/update_readme

Browse Source 
Update readme
This commit is contained in:
raziman 2020-08-12 14:31:02 +08:00 committed by GitHub
commit cc80d5a929
1 changed files with 47 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -17,7 +17,7 @@ Gomu is a Terminal User Interface **TUI** music player to play mp3 files from yo
- customizeable - customizeable
## Dependencies ## Dependencies
If you are on ubuntu, you need to install alsa as required dependencies If you are using ubuntu, you need to install alsa and required dependencies
```sh ```sh
$ sudo apt install libasound2-dev go $ sudo apt install libasound2-dev go
``` ```
@ -33,38 +33,59 @@ go get -u github.com/issadarkthing/gomu
## Configuration ## Configuration
By default, gomu will look for audio files in `~/music` directory. If you wish to change to your desired location, edit `~/.config/gomu/config` file By default, gomu will look for audio files in `~/music` directory. If you wish to change to your desired location, edit `~/.config/gomu/config` file
and change `music_dir: path/to/your/musicDir`. Example of the config file will look like: and change `music_dir: path/to/your/musicDir`.
Sample config file:
``` ```
confirm_on_exit: true color:
music_dir: ~/music accent: "#008B8B"
confirm_bulk_add: true background: none
popup_timeout: 5 foreground: "#FFFFFF"
now_playing_title: "#017702"
playlist: "#008B8B"
popup: "#0A0F14"
general:
confirm_bulk_add: true
confirm_on_exit: true
load_prev_queue: true
music_dir: ~/music
popup_timeout: 5s
volume: 100
emoji: true
``` ```
## Keybindings ## Keybindings
| Key | Description | | Key | Description |
|--------|------------------------| |:----------------|-----------------------:|
| j | down | | j | down |
| k | up | | k | up |
| tab | change panel | | tab | change panel |
| space | toggle play/pause | | space | toggle play/pause |
| esc | close popup | | esc | close popup |
| n | skip | | n | skip |
| q | quit | | q | quit |
| l | add song to queue | | l (lowercase L) | add song to queue |
| L | add playlist to queue | | L | add playlist to queue |
| h | close node in playlist | | h | close node in playlist |
| d | remove from queue | | d | remove from queue |
| D | delete playlist | | D | delete playlist |
| + | volume up | | + | volume up |
| - | volume down | | - | volume down |
| Y | download audio | | Y | download audio |
| a | create playlist | | a | create playlist |
| ? | toggle help | | ? | toggle help |
## Project Background ## Project Background
I just want to implement my own music player with a programming language im currently learning [Go](https://golang.org/). Gomu might not be stable as it in constant development. For now, it can do basic music player can do like adding, deleting songs from queue, skip, play, pause but not seeking or more advanced stuff; feel free to contribute :) I just wanted to implement my own music player with a programming language i'm currently learning ([Go](https://golang.org/)). Gomu might not be stable as it in constant development. For now, it can fulfill basic music player functions such as:
- add and delete songs from queue
- create playlists
- skip
- play
- pause
Seeking and more advanced stuff has not yet been implemented; feel free to contribute :)