mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-13 21:14:17 +00:00
initial commit
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Config
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
The showbridge router's config is entirely controlled by a YAML/JSON config file. This file must be made by hand for now. I do provide some starter/example configs to look at to get a general idea of what one entails.
|
||||
|
||||
Resources
|
||||
- good idea to start with [config.yaml](https://github.com/jwetzell/showbridge-go/blob/main/config.yaml)
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Dictionary
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **router**: throughout documentation I will use the term router to refer to configured/running instance of showbridge
|
||||
- **modules**: modules are configured instances that can produce or consume message like a TCP server or a UDP client
|
||||
- **routes**: routes take messages coming from a module (input), do some optional processing and send that message to a module (output)
|
||||
- **processors**: processors process messages, the processors are localized to the route the processor is a part of. Examples of processors or turning bytes into an OSC message or parsing a string into an integer
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Modules
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Processors
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Routes
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
Reference in New Issue
Block a user