Melodex

A terminal-based music player designed for playing locally stored music.

Overview

Every great project begins with an idea—mine was to create a terminal-based music player. But why use one? What’s the purpose behind it?

There aren’t many terminal-based music players available, yet for typical Unix-based OS users, TUIs (Text-based User Interfaces) are an essential tool and often the preferred way to interact with software. Given the limited options in this space, Melodex aims to fill that gap, offering a simple yet powerful solution for those who embrace a terminal-first workflow.

Installation

For installation instructions, refer to Installation.md.

Usage

Basic Usage

melodex <command> [options]

Commands

-c, --settings             Open configuration options.
-h, --help               Display this help message.
-p, --playlist           Specify a playlist to use.
-cc, --clear-cache       Clear all cached song data.
-v, --version            Show version information.
--default-settings         Restore default configuration settings.
-sp, --stored-playlist   Select an indexed playlist from the settings.

Demonstration

Features & Functionality

Melodex offers a range of features designed to enhance your terminal-based music experience:

• Music Playback
  Play locally stored audio files with ease.
• Multiple Playlists
  Create and manage multiple playlists for different moods and occasions.
• Sleep Control
  Set timers to stop playback automatically.
• Volume Control
  Adjust volume levels directly from the terminal.
• Shuffle & Repeat
  Shuffle songs or loop tracks and playlists.
• Search & Filter
  Quickly find specific songs or filter your library by artist, album, or genre.
• Custom Configuration
  Tailor settings to your preferences for a personalized experience.
• Logging
  Keep track of playback history and system logs for troubleshooting.

Additionally, Melodex uses several libraries listed in Libraries.md.

Contributing

Want to contribute? Check out Contributing.md for guidelines on how to get involved.

License

This project is licensed under the GPLv3 license. For details, check out the GNU General Public License v3.

Contact & Support

If you need assistance, have a question, or want to contribute to the project, here’s how you can reach out:

• Issues & Contributions
  Check out the issues and contribution guidelines to see how you can help improve Melodex.
• Reporting Bugs & Requests
  Encounter a problem or have a feature suggestion? Feel free to open an issue.
• Direct Support
  For direct inquiries, contact the project leader via email: [email protected].

Acknowledgments

A special thanks to the following contributors who helped bring Melodex to life:

ohSystemmm – Lead Developer:
Conceived the idea and implemented most of the project. Y2kun – Contributor:
Designed and implemented the TUI. nvmChris – Assistance:
Provided support and guidance to the developers.

Initial Start: July 2024
Concept and early development by ohSystemmm.
Official Project Launch: October 2024
Established as an official project, marking the arrival of Y2kun and nvmChris as contributors.