Skip to content
AlxiicePublic

About

Another Music Player : a local music player based on Youtube Music library.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

AMP

Another Music Player : a local music player based on Youtube Music library.

Python CI Code Coverage Tauri Build Documentation

AMP is a desktop app that plays music from the YouTube Music library. Songs are downloaded in small segments and cached on disk, so playback starts fast and you can seek right away. Search and playback work without an account; signing in with YouTube adds your liked songs and playlists.

AMP playing a song, with search results and the queue

  • Fast playback: ~10 s segments, cached songs start in about 24 ms, seek anywhere at once
  • Queue with drag and drop, shuffle and restore, repeat, saved queues; restored on restart
  • Your library: liked songs and playlists after an optional YouTube sign-in
  • Listening history with the share of each song you actually heard
  • Settings: dark, light or system theme, any accent colour, crossfade, volume normalization
  • OBS now-playing widget on its own local port, for streamers, with its size, colours and opacity set in the app
  • Copy YouTube link from any song's menu
  • Developer tools: a Developer page in the app and the app.py launcher

The OBS now-playing widget

Requirements

  • Python 3.10 or newer
  • Node.js 18 or newer, on your PATH. AMP needs it at runtime too, not just to build.
  • Rust toolchain (rustup.rs)

Launch the app

From the repository root:

cd amp
python -m venv venv
venv\Scripts\activate              # Linux/macOS: source venv/bin/activate
pip install -r requirements.lock
python scripts/build_sidecar.py    # first time only

cd frontend
npm install
npm run tauri dev

The AMP window opens. The first run takes a few minutes while Rust compiles. The app starts its own backend and stops it when you close the window.

Later launches only need the last command:

cd amp/frontend
npm run tauri dev

On Windows you can also double-click AMP.bat at the repository root, which runs the same command. To run the built app instead of the dev mode, see Rebuild and run.

Download

Ready-made builds for Windows, macOS and Linux are on the Releases page. You still need Node.js on your PATH to play songs.

Build it yourself

All builds go through one script, run from amp/ with the venv active. It builds the backend executable, then the Tauri app, and copies everything into a build/ folder at the repository root:

cd amp
python scripts/build_release.py              # executable + every installer for this system
python scripts/build_release.py --exe-only   # just the executable, no installer

What you get in build/:

Path What
AMP-1.1.0-<os>-<arch>/ AMP[.exe], amp-backend[.exe] and, on Windows, WebView2Loader.dll. Keep them together; run AMP to start. Nothing to install.
AMP-1.1.0-<os>-<arch>.zip / .tar.gz the same folder, archived
installers/ .msi and -setup.exe on Windows, .dmg on macOS, .deb and .AppImage on Linux

Pick installer types with --bundles, e.g. --bundles deb,appimage or --bundles nsis. Add --smoke to start the backend executable once and check that it works before packaging.

Tauri only builds for the system it runs on, so a Windows machine makes Windows builds, and so on.

Rebuild and run after small changes (Windows)

Double-click AMP-build-and-run.bat at the repository root (or run python scripts/build_release.py --run from amp/). It rebuilds only what is older than its sources (the backend executable, then the app), skips the installers and the archive, and starts build/AMP-1.1.0-windows-x64/AMP.exe. When nothing changed it starts the app right away. It needs the venv in amp/venv from Launch the app.

Making a release

The Release workflow builds on Windows, macOS and Linux with the same script. To publish a version:

  1. Set the version in amp/frontend/src-tauri/tauri.conf.json, Cargo.toml and package.json, and add an entry to CHANGELOG.md (it becomes the release notes).
  2. Commit, then tag and push: git tag v1.0.0 && git push origin v1.0.0.
  3. When the workflow is done, a draft release with all the files is waiting on GitHub. Check it and publish it.

Documentation

The full documentation (usage guide and code reference) is available on GitHub Pages:

📚 https://Alxiice.github.io/AMP/

The docs are built with MkDocs from the docs/ directory in this repository. To build and preview them locally:

pip install -r docs/requirements.txt
mkdocs serve                       # then open http://127.0.0.1:8000
Install & launch prerequisites, setup, installers, updating yt-dlp
Using the app search, player, queue, history, settings, Developer page
OBS widget show the current song on stream
Developer launcher app.py: run and inspect the backend and frontend
Troubleshooting when a song won't play, the app won't start…
Code architecture, backend, frontend, tests, CI

License

AMP is released under the Mozilla Public License 2.0. It comes with no warranty, and the authors aren't liable for how it's used. AMP isn't affiliated with YouTube or Google, and downloading from YouTube with yt-dlp may go against YouTube's Terms of Service: using it is your responsibility. See LICENSE for the full text and NOTICE for the disclaimer.

About

Another Music Player : a local music player based on Youtube Music library.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages