Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.85 KB

README.md

File metadata and controls

63 lines (37 loc) · 1.85 KB
Raw

About

Various apps and libs for interacting with QLab workspaces

Development Setup

To run this project make sure you have the following installed:

  • Golang
  • Gow
  • NodeJS
  • (Optional) to run the swagger codegen, you must also have a Java SDK on your path

Run npm install

Build and run commands can be found in the script section of this projects package.json

(App) Goodwin

Goodwin is a SvelteKit application for configuring voice commands that trigger QLab cues

Develop locally with npm run start:goodwin

See Project README for more info

(App) Qlab Rest

QLab Rest proxies http requests to QLab as OSC messages

Develop locally with npm run start:qlab-rest

See Project README for more info

(App) voice-cmd

Voice cmd is an example application that demonstrates speech-to-text commands that trigger QLab cues

Develop locally with npm run start:voice-cmd

See Project README for more info

(Lib) Proxy

Proxy is a go library for interacting with QLab via TCP

Documentation

(Generator) Scraper

Scraper reads the QLab OSC dictionary page from https://qlab.app/docs/v4/scripting/osc-dictionary-v4/ and creates a OpenAPI V3 specification file

Usage: npm run scraper or npx nx workspace-generator scraper --dir=some/directory

TODO

  • Trigger an API endpoint using speech-to-text
  • Initial speech-to-text proof of concept
  • Use speech-to-text to trigger a QLab workspace cue
  • Translate JSON to OSC messages
  • Implement the QLab OSC API
  • Convert server implementation to Rust or Go for smaller binaries
  • Release binaries on Github
  • Create a GUI for configuring/triggering QLab cues