initial commit

This commit is contained in:
Joel Wetzell
2025-12-03 17:58:59 -06:00
commit 63e9108fb2
21 changed files with 8035 additions and 0 deletions
+9
View File
@@ -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)
+10
View File
@@ -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
+5
View File
@@ -0,0 +1,5 @@
---
title: Modules
sidebar:
order: 3
---
+5
View File
@@ -0,0 +1,5 @@
---
title: Processors
sidebar:
order: 5
---
+5
View File
@@ -0,0 +1,5 @@
---
title: Routes
sidebar:
order: 4
---