/melody

Standalone cross-platform music player.

Primary LanguageRustMIT LicenseMIT

Melody

Standalone cross-platform music player.

Features

  • Theming support.
  • Extensible plugin support.
  • Niche features like re-encoding and tagging.

Development

If you are interested in contributing to this project, make sure to go through the specification first.

Prerequisites

1. Compiling ffmpeg

FFmpeg is compiled through the vcpkg definition in the backend/Cargo.toml. Just run cargo vcpkg build.

2. Environment

For rsmpeg to resolve the ffmpeg binaries, FFMPEG_PKG_CONFIG_PATH needs to be set.

# Linux and macOS
./scripts/setup_unix.sh

# Windows
./scripts/setup_windows.ps1

Starting

  1. Run pnpm i in the workspace root.
  2. Run pnpm build:packages to build the projects in packages/.
  3. Build the project with cargo build.
  4. Start the backend by running pnpm run dev:backend with RUST_LOG = "none,backend=debug" env.
  5. Start the web server with pnpm dev:app.

License

This project is license under MIT. See LICENSE for the specifics.