Metadata-Version: 2.3
Name: mad-play
Version: 0.1.0
Summary: Play music in the terminal like a divine madman!
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# Mad Play

**Play your music from the terminal like a Divine Madman!**

[![PyPI - Version](https://img.shields.io/pypi/v/-.svg)](https://pypi.org/project/mad-play)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/-.svg)](https://pypi.org/project/mad-play)

-----

## Installation

```console
pip install mad_play
```

## Usage

For ease of use you could add an alias to your `.bashrc`, for example:

```bash
alias = mp="mad-play"
```

Remember to close and re-open your terminal or run:

```bash
source ~/.bashrc
```

Then open your terminal where the music is. To play a file:

```bash
mp funkytown.mp3
```

If you have a list of filenames in a text file, one filename per line and you have given it the .playlist extension, you can start playing it by:

```bash
mp bebop.playlist
```

Or just play every audio file in a folder like so:

```bash
mp mongolian/
```

press `space` to pause and resume, `n` for next tune, `b` to go back and `q` to quit.

## Project scope

Dead simple terminal audio player that plays audio files from anywhere on your computer, with playlists edited as plain text files and the ability to play everything in a folder. The player has intuitive controls and does not require learning exotic key-bindings.

## Contribute

This is a fun, simple project, but very useful all the same. It's a single python file with code that is fairly easy to catch. Mind you, it's early days and everything very raw. The Divine Madman invites you all to tinker, suggest improvements within the scope of the project and contribute improvements if doing so tickles your fancy! 

## License

`-` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
