eshrh / osu-cplayer

fast and featured command line osu! song player built on mpv

Development of this project has moved to gitlab

osu-cplayer

Fast, compact, and featured command line osu! song player built on mpv.

Installation

1. Install osu-cplayer via pip: pip install osu-cplayer
2. Install mpv
3. On first run, enter the absolute paths of your songs folder, collections.db file and osu!.db file
4. These settings get saved in your home folder as ~/.osupaths or equivalent.

I've tested this on gnu/linux and macos, and it works. Windows is untested though, I'd appreciate someone trying it out.

Usage

• Previous/Next Song: left/right
• Move Selection: up/down, left click, or scroll
• Play song: enter or double click
• Toggle play/pause: p
• Restart song and play: r
• Quit: q or esc
• Add song to queue: a
• Clear queue: A
• Shuffle: s
• Sort alphabetically(default): S
• Sort by date added: d
• Filter: : or mouse followed by filter term
  • Reset filter: esc
  • Exit text box: any special key or mouse
• Filter by Collection: c or mouse, followed by collection name, and enter
• Open this help page: ?

Other

osu!.db reading code is taken from OsuDbReader

Dependencies

• Python 3.6+
• python-mpv
• urwid
• tinytag

TODO

• holy hell please refactor lmao. If anyone looks at my code, I apologize in advance. This is ultra hacky and I really just wanted to build this to use for myself ASAP