Build

Compiling Plugger is fairly simple; however it is recommended to use Python 2.7 since the Plex framework is using Python 2.7.

Clone

Ensure git is installed and run the following:

git clone https://github.com/lizardbyte/plugger.git plugger.bundle
cd ./plugger.bundle

Setup venv

It is recommended to setup and activate a venv.

Install Requirements

Install Requirements
python -m pip install --upgrade --target=./Contents/Libraries/Shared -r requirements.txt --no-warn-script-location
Development Requirements
python -m pip install -r requirements-dev.txt

Build Plist

python ./scripts/build_plist.py

npm dependencies

Install nodejs and npm. Downloads available here.

Install npm dependencies.
npm install
Move modules directory.
Linux/macOS
mv ./node_modules ./Contents/Resources/web
Windows
move .\node_modules .\Contents\Resources\web

Remote Build

It may be beneficial to build remotely in some cases. This will enable easier building on different operating systems.

  1. Fork the project
  2. Activate workflows
  3. Trigger the CI workflow manually
  4. Download the artifacts from the workflow run summary