Skip to content

Installation

Flatpak

Download on Flathub

GitHub

  1. System Dependencies

    Please follow the guide that matches your distro the most:

    Arch Linux

    On Arch Linux (and possibly other distros) you may need to install the following system packages using the distribution specific package manager:

    xdg-desktop-portal xdg-desktop-portal-gtk libportal libportal-gtk4
    

    Ubuntu Linux

    On Ubuntu Linux (tested on 24.04.1 LTS) you may need to install the following system packages using the distribution specific package manager:

    gir1.2-xdpgtk4-1.0 libgirepository1.0-dev libportal-gtk4-1 libportal-gtk4-dev
    

  2. Clone StreamController from GitHub by typing:

    git clone https://github.com/Core447/StreamController
    

  3. Enter the StreamController directory:
    cd StreamController
    
  4. Create a virtual environment:
    python3 -m venv .venv
    
  5. Activate the virtual environment:
    source .venv/bin/activate
    
  6. Install pip requirements:

    pip install -r requirements.txt
    

  7. Optional: Switch branches

    If you want to try out a specific branch, you can change the branch using:

    git checkout <branch>
    

  8. Launch the app:

    python3 main.py
    

Unofficial packages

The following packages are functional but unofficial and maintained by our community:

Packaging status


Help

If you encounter any problems, please go through Common Problems. You can also open an issue on the StreamController GitHub repository or on the Discord.