Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.48 KB

README.md

File metadata and controls

52 lines (32 loc) · 2.48 KB
Raw

teamus

Dead simple terminal music player written in go.

teamus.mp4

This shows the mouse, seek, play/pause and other features.

(I had to search for music with no copyright. The two music played are Rumors by Neffex, and Cold Funk by Kevin MacLeod. The recording app is Kooha.)

Purpose

Pretty Keyboard centric Terminal Music Player in Go using the popular Charm TUI, with Vim Keybindings

Most Terminal Music Player today is either not pretty, or have the most unintuitive key bindings. This one is meant to be pretty, without being much resource intensive. Written in Go, it can search for all audio files in your Music Folder, and then Play the songs on enter. Check out the project, and click the question mark ? to get more help. I love cmus, but it isn't pretty, so now we get teamus.

Build Instructions

For now, you have to have the golang binary installed. For that, check out, check out "How to Build and Install Go Programs". After that just clone this repository, and type go run .. Or maybe you can build the repository using go build. Also, you can test this repo by using the command go run github.com/aretrosen/teamus@latest.

NOTE: This was made in a Linux environment, with a Music directory. There are plans to add directories via json/yaml file later, but for now you need to have the $HOME/Music directory. As mentioned by @LeonardsonCC, this works perfectly fine on Windows, and now it does have the capability to scan other directories which is configured as shown below.

Configuration

You can specify a list of song directories by creating a JSON file at $HOME/.config/teamus/teamus.json or $HOME/.teamus.json. File example:

{
  "directories": ["/home/user/Music", "/home/user/My_Musics"]
}

To-dos

  • Seamless Playing
  • Shuffle
  • Repeat Music / Playlist
  • Choose files from multiple directories, specified in json.
  • Load from database, refresh only on key press.

Additional Features

  • show lyrics on key press.
  • basic mouse support added now. If more support is needed, I might consider using bubblezone module.
  • play m4a audio. Currently, even not all opus files run correctly. I might have to write many of the audio frameworks from scratch.

Collaboration

You're welcome to write features and report issues for this project.