Building

These are the general steps to building Tauon:

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

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 libpipewire

   sudo dnf install ffmpeg-devel gcc gcc-c++ pygobject2-devel python3-gobject libjxl-devel libnotify-devel librsvg2-devel SDL3-devel SDL3_image-devel flac-devel game-music-emu-devel opusfile-devel libopenmpt-devel libsamplerate-devel libmpg123-devel libvorbis-devel wavpack-devel google-noto-fonts-common google-noto-cjk-fonts

   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 (no longer needed on SDL 3.6.0+)
   • 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. Build Tauon via pip install .

7. 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.