Building

These are the general steps to building Tauon:

1. Clone Tauon repo git clone https://github.com/Taiko2k/TauonMusicBox.git then cd TauonMusicBox.

2. Init submodules using git submodule update --init --recursive.

3. Install system dependencies. Package names might differ between distros.

   Arch Linux

   Installing the AUR package will provide the needed dependencies.

   Fedora

   todo add libgme, libpipewire

   sudo dnf install gcc pygobject2-devel libnotify-devel SDL3-devel SDL3_image-devel wavpack-devel flac-devel libvorbis-devel opusfile-devel libopenmpt-devel libsamplerate-devel libmpg123-devel

   Debian/Ubuntu

   sudo apt install -y libayatana-appindicator3-dev gir1.2-rsvg-2.0 libpipewire-0.3-dev libdbus-1-dev fonts-noto gir1.2-notify-0.7 libcairo2-dev python3-gi-cairo libwavpack-dev libsamplerate0-dev libopenmpt-dev libvorbis-dev libopusfile-dev libflac-dev libgme-dev libmpg123-dev

   Note that SDL3 (libsdl3 libsdl3-image) is not packaged yet

   Generic

   • pygobject
   • ffmpeg
   • libnotify
   • sdl3
   • sdl3-image
   • libwavpak
   • flac
   • libvorbis
   • libopusfile
   • libopenmpt
   • libsamplerate
   • libappindicator
   • libmpg123
   • librsvg
   • noto-fonts (optional)
   • noto-fonts-cjk (optional)

4. Setup a python venv python -m venv venv

5. Activate the venv source venv/bin/activate

6. Install python dependencies. You can use pip install -r requirements.txt.

7. Run ./run.sh and select Compile Phazor with PipeWire support.

8. Run python compile_translations.py (optional).

9. To start Tauon, run python src/tauon/__main__.py.

If you run into issues and think these instructions are wrong/out-of-date, you can check what the CI action does and compare - open an Issue if it does turn out to be this way.