shrimp

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2024 License: GPL-3.0 Imports: 9 Imported by: 0

README

Shrimp

Go Report Card Build Status

A fussless command line music player.

Why?

Shrimp started as a weekend project, with the objective to create a bare-bones music player to suit my usecase (i.e. streams), while adhering to the KISS principle.

I wouldn't consider myself revinventing the wheel if most wheels are heavy and bloated.

Imaginary QnA

I need my features

No you don't. Even if you do, they should be handled by external programs (eg. EQ).

Shrimp is mainly intended to play radio streams, many conventional music player features would not apply. Does your FM radio have those fancy features?

mpv is better

Not in terms of resource usage. Playing audio with a full-fledged video player is an overkill. That being said, the difference is negligible in practice, especially with modern hardware.

True.

How do I find radio stations, is there a curated list?

We don't shill stations here, not even my own. If you are lost, try http://dir.xiph.org/codecs/Vorbis.

Why shrimp, if not cRustacean

It's the best euphemism I can think of when you pin together "Simple Internet Music Player". I like Rust, though.

Usage

Prerequisite

If on Linux, make sure ALSA is installed, and an audio server is running (PipeWire/PulseAudio)

Build

make build to produce the executable.

Run

./shrimp <Stream-URL> to play a stream over http(s).

./shrimp -f -s <file-location> to play a local file, drop the -s flag to loop ad infinitum.

Platforms

Cross-platform functionality is supported by Oto's drivers.

Supporting Codec(s)

Ogg Vorbis

Meme

not a mascot

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL