Skip to content

Building for Windows

Martin edited this page Dec 27, 2024 · 52 revisions

Tauon for Windows can be built using MSYS2

  1. Go to http://www.msys2.org/ and download the x86_64 installer
  2. Follow the instructions on the page for setting up the basic environment
  3. Run C:\msys64\mingw64.exe - a terminal window should pop up
  4. Update and install git by running pacman -Syu git --noconfirm - You may need to reopen mingw64.exe after this
  5. Clone Tauon repo git clone https://github.com/Taiko2k/TauonMusicBox.git --recursive
  6. cd TauonMusicBox
  7. Execute pacman -S --needed --noconfirm - < extra/msyspac.txt to install required dependencies
  8. (optional) Download (or compile: cargo install librespot) and place librespot.exe in the root of the folder
  9. (optional) Download (or compile as per instructions in extra/TaskbarLib.idl) and place TaskbarLib.tlb in the root of the folder
  10. Execute pip install -r requirements.txt to install python dependencies
  11. Compile needed Tauon modules using ./run.sh and select Compile Phazor
  12. (optional) Compile translations using python compile_translations.py
  13. (optional) Add recommended fonts: In source directory, create a directory named fonts, and place Noto Sans font files in there.
    Easiest way to get these is to copy the folder from an existing Tauon installation
  14. (optional) Download or build the SMTC module, which is needed for the media keys to work.
    You can also grab this from an existing installation if you're lazy, the code doesn't change often:
    1. Install via Visual studio:
      1. Install Visual Studio
      2. Open src/smtc/TauonSMTC.sln
      3. Select the release configuration and build
      4. From the build directory copy TauonSMTC.dll to /lib
    2. Install via MS Build Tools in cmd.exe (MSBuild.exe):
      1. Install MS Build Tools
      2. Open cmd.exe and set the PATH variable to the tools: set PATH=%PATH%;C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin
      3. Run msbuild.exe /p:Configuration=Release TauonSMTC.sln
  15. You should now be able to run using python src/tauon/__main__.py
    To package into an exe: ./run.sh and select Windows Build, then the resulting build will be in the dist directory.

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.

Clone this wiki locally