https://github.com/jwetzell/showbridge
highly configurable protocol router
https://github.com/jwetzell/showbridge
bridge cloud companion control midi mqtt osc osculator protocol show tcp theater theatre udp websocket
Last synced: about 1 month ago
JSON representation
highly configurable protocol router
- Host: GitHub
- URL: https://github.com/jwetzell/showbridge
- Owner: jwetzell
- License: mit
- Created: 2023-08-03T14:54:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T00:56:07.000Z (about 1 month ago)
- Last Synced: 2025-04-15T23:14:22.180Z (about 1 month ago)
- Topics: bridge, cloud, companion, control, midi, mqtt, osc, osculator, protocol, show, tcp, theater, theatre, udp, websocket
- Language: TypeScript
- Homepage: https://demo.showbridge.io
- Size: 11.6 MB
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# showbridge
Simple protocol router _/s_
[Run](#how-to-run) •
[CLI Usage](#cli-usage) •
[Config File](#config-file) •
[Docs](#docs)
### Supported Protocols
- HTTP & WebSocket
- OSC (via UDP and TCP)
- UDP
- TCP
- MQTT
- MIDI
### How to run
- Launcher
- download/install [launcher](https://github.com/jwetzell/showbridge/releases) this is the easiest method to get up and running and includes the web interface and logging
- run showbridge!
- NPM
- create a config file (see below)
- optionally install globally: `npm install -g @showbridge/cli`
- run
- if installed globally: `showbridge -c config.json`
- via npx: `npx @showbridge/cli@latest -c config.json`
- this method still has the web interface available via HTTP
- use the `-h` flag to see other available flags
- Source
- clone repo
- install dependencies: `npm install && npm run install:all`
- run: `cd cli && npm run start -- -c config.json`
- see [CLI Usage](#cli-usage) for more flags
- if no config file is specified then a [default config](sample/config/default.json) will be used
- to run the launcher
- `cd launcher`
- `npm run start`
## CLI Usage
```
Usage: @showbridge/cli [options]
Simple protocol router /s
Options:
-V, --version output the version number
-c, --config location of config file
-v, --vars location of file containing vars
-w, --webui location of webui html to serve
--disable-action action type(s) to disable
--disable-protocol protocol type(s) to disable
--disable-trigger trigger type(s) to disable
--disable-transform transform type(s) to disable
-l, --log-level log level (choices: "trace", "debug", "info", "warn", "error", "fatal", default: "info")
-h, --help display help for command
```
## Config File
The showbridge router's config is entirely controlled by a JSON config file. This file can be made by hand or edited via the web interface included with the launcher. The router WILL NOT start up with an invalid config file. I do provide some starter/example configs to look at to get a general idea of what one entails.
Resources
- the [JSON Schema](https://docs.showbridge.io/schema/config) used to validate the config file
- good idea to start with [default.json](sample/config/default.json)
- [random examples](sample/config/)
- the [demo](https://demo.showbridge.io) site can be used to import/edit/create configs that can be downloaded
## Docs
For more information about showbridge and its inner workings check out the [documention](https://docs.showbridge.io)