Skip to content

nebulabroadcast/firefly

Repository files navigation

Firefly

GitHub release (latest by date) Maintenance Last commit Python version

Firefly is a desktop client application for Nebula broadcast automation system.

Installation

Running from source (all platforms)

  • Install Python 3.10+ and Poetry.
  • Clone this repository.
  • Run poetry install to install dependencies.
  • Run poetry run python -m firefly to start the application.

The following packages may be needed on Linux, in case you don't have them already installed, run sudo apt install libmpv1 libxcb-util1 on Ubuntu or sudo apt install libmpv1 libxcb-util0 on Debian.

Windows

Latest binary release is available on nebulabroadcast/firefly GitHub releases page.

Configuration

Edit settings.json file to set your server address and site name.

{
    "sites"  : [{
        "name" : "nebula",
        "host" : "https://nebula.example.com"
    }]
}

It is possible to specify more than one site in the settings.json file. In that case, a dialog window pops up when the application starts and a you may select the site for this session.

Usage

Introduction to Firefly

Troubleshooting

Have you tried turning it off and on again?

In most cases, this helps. If the application worked and suddenly it is not possible to start, try to delete ffdata files in its directory and start it again.