add README

This commit is contained in:
Franzi 2023-08-08 06:34:26 +02:00
parent b6b57783ed
commit 76f4f3f024
Signed by: kunsi
GPG key ID: 12E3D2136B818350

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# Viri Alerts to DMX lights (via sACN)
This software will convert incoming alerts from the #voc-wok irc channel
into sACN messages, so the alerts can be shown on some dmx lights.
We currently support the following lighting fixtures:
- [Ignition WAL-L710 Par](https://www.thomann.de/gb/ignition_wal_l710_par_w_dmx.htm)
(only W-DMX version was tested)
- [Varytec Hero Wash 712 Z RGBW Zoom](https://www.thomann.de/gb/varytec_hero_wash_712_z_rgbw_zoom.htm)
(pan/tilt fixed to center)
- [WLED "multi RGB"](https://kno.wled.ge/interfaces/e1.31-dmx/)
For all options, please have a look at our [example config file](config.example.toml)
which lists all available configuration values including some explaination.