Skip to content

Developer Guide

Jump to bottom
Elijah Lopez edited this page Jan 10, 2022 · 54 revisions

Although Music Caster was made using Python 3.10.1 64-bit. If you want to build the Updater.exe that's found in Portable.zip, you'll need to install Golang.

If you want to build the 32-bit version, you'll need Python 3.8 32-bit and will need to use the v4-py3.8.9-32-bit branch.

This document may be outdated and is not guaranteed to work.

Python Installation

Windows

Ensure

  1. Python is added to the PATH environment variable (it'll be a checkbox in the installer)
  2. pip is installed

Ubuntu

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.10 -y
sudo apt install python3.10-distutils -y
sudo apt install python3-pip -y
sudo apt-get install python3-dev
cd src && python3.10 -m pip install -r requirements.txt

After installation, check if these two options were selected by opening a new terminal (cmd or wt on Windows) window and enter the command pip and then python --version. If you get any "is not recognized" errors, you did not add Python and pip to the PATH environment variable.

Setting up

  1. Clone this repository or download the master branch and extract.
  2. Go into the music-caster directory.
  3. Open up a command prompt within this directory. The way I do this on Windows is Ctrl + L -> wt -> <<Enter>>. Type cmd instead of wt if you don't have Windows Terminal installed.
  4. Install dependencies by running either build --dry or cd src && pip install -r requirements.txt --user
  5. To run the program with Python, you can use py music_caster.py. Supply -m or set DEBUG: true in settings.json if you don't want the GUI to open up on every run.

Building

  • Use ./build.cmd --no-install in the terminal (pwsh/cmd) to build Music Caster, a portable version, and an installer (setup.exe)

You will most likely see "WARNING: could not create an installer" when building. You can ignore this if you don't plan to create the setup installer yourself. If you want to create the setup installer, you will need to install Inno Setup and make sure that its installation folder is added to PATH before building again (will need to restart the terminal or IDE you were using).

Trouble Shooting

Something to note is that Chromecasts do not support IPv6 links.

Clone this wiki locally