Usage¶
This section is for people who want to run AMP and use it.
| Page | Read it when you want to… |
|---|---|
| Install & launch | download AMP, or run and build it from source |
| Using the app | find your way around: search, the player bar, the queue, logs |
| Signing in | see your liked songs and playlists |
| Configuration | change the cache size, the port, the audio format… |
| OBS now-playing widget | show the current song on a stream |
| Developer launcher | work on AMP: start the backend and frontend, read logs, test the API |
| Troubleshooting | fix "Node.js not found", a song that won't play, an expired session… |
| Manual runs | run the backend by hand, use the app in a browser |
The short version¶
The easiest way is to download a build from the Releases page and install Node.js. To run it from the source code instead:
cd amp
python -m venv venv
venv/Scripts/activate # Unix: source venv/bin/activate
pip install -r requirements.lock
python scripts/build_sidecar.py # once; Tauri needs this file to exist
cd frontend
npm install
npm run tauri dev # opens the app
You need Python 3.10+, Node.js and the Rust toolchain. See Install & launch for details.