Skip to the content.

Download Beam

All Releases

Run from source (all platforms)

If there is no packaged build for your system, you can run Beam directly with Python 3 and the dependencies in requirements.txt.

Clone or download the repository, open a terminal in the project root, and create a virtual environment.

Windows

py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install -r requirements.txt
python .\beam.py

Linux

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
python beam.py

macOS

Use the same Python steps as Linux. See the collaborator packaging guide in BUILD_MACOS.md and the build notes in ../BUILD.md.

Having trouble?

See Troubleshooting, or report an issue: https://github.com/MrNidnan/beam-project/issues


Home · Download · Getting Started · Features · Player Support · Network Display · Live Display Controls · Moods & Backgrounds · Troubleshooting · Changelog