Skip to content

jeremystevens/terminal-music-player

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

TermTunes

License

Screenshot

TermTunes is a minimalist console-based music player for Linux and macOS, allowing you to play and manage your music collection directly from the terminal.

Features

  • Lightweight and easy-to-use.
  • Play MP3, OGG, and WAV audio files.
  • Navigate and select songs using the arrow keys or keyboard shortcuts.
  • Play, pause, and stop playback.
  • Clean and intuitive terminal interface.

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/TermTunes.git
    cd TermTunes
  2. Install the required dependencies (e.g., mpg123 for audio playback):

    sudo apt-get install mpg123

3 Run TermTunes

python termtunes.py

Usage

Use the arrow keys or keyboard shortcuts to navigate through your music collection.

  • Press 'p' to play the selected song.
  • Press 's' to stop playback.
  • Press 'x' to exit TermTunes.

License

This project is licensed under the GNU General Public License v3.0.

You can view the full text of the license here.

Please note that by contributing to this project, you agree to abide by the terms of this license.

Acknowledgments

  • termTunes was inspired by the love for command-line interfaces and music.
  • Special thanks to the open-source community for providing valuable resources and tools.

Contributing

We welcome contributions from the community. If you'd like to contribute to TermTunes, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
  3. Make your changes and commit them: git commit -m 'Description of your changes'.
  4. Push your changes to your fork: git push origin feature-name.
  5. Create a pull request (PR) on the GitHub repository.

Please make sure to:

  • Provide a clear and descriptive title for your PR.
  • Describe the purpose of your changes and the problem they solve.
  • Follow the existing coding style and conventions.
  • Include relevant tests for your changes if applicable.
  • Ensure that your code is well-documented.

I will review your contribution, and if it aligns with the project's goals and standards, we'll merge it. Thank you for helping improve TermTunes!

Contact

For bug reports, feature requests, or general inquiries, please create an issue on the GitHub repository.

About

TermTunes is a minimalist Python application for playing your music collection directly from the terminal.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages