https://github.com/kryops/vlight
Simple web-based DMX lights controller.
https://github.com/kryops/vlight
dmx
Last synced: 5 months ago
JSON representation
Simple web-based DMX lights controller.
- Host: GitHub
- URL: https://github.com/kryops/vlight
- Owner: kryops
- License: mit
- Created: 2018-12-27T07:59:16.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-04T15:18:08.000Z (about 1 year ago)
- Last Synced: 2025-04-04T16:34:29.536Z (about 1 year ago)
- Topics: dmx
- Language: TypeScript
- Homepage:
- Size: 8.63 MB
- Stars: 10
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# vLight
Simple web-based DMX lights controller.
> **🚧 This project is still Work in Progress! 🛠️**
>
> It has been used for real events, but it's not battle-tested yet. **Use at your own risk**.
>
> Check out the [TODO list](./TODO.md) for the roadmap of planned features.
>
> Feel free to fork and experiment - PRs welcome.
> 🎵 Also check out this project's companion app [remote-mixer](https://github.com/kryops/remote-mixer) for remote-controlling sound mixers.
## Features
- 📱 Responsive and mobile-friendly
- 🚀 Lightweight and performant
- 🕸️ Connect multiple clients
- 🌓 Light and dark mode
- 📄 Configurable Dynamic Pages
Controls
- 🎚 DMX Channels
- 💡 Fixtures
- ꙮ Fixture Groups
- 🖼 Memories
- 🎞 Live Chases
- 🗺 Map Overview
- ✨ Universe Overview
- 🌎 Global Master / Blackout
Inputs
- 🖱 Mouse
- 📱 Touch
- ⌨️ Keyboard (partial)
- (Planned: 🕹 Physical input devices)
Supported DMX Interfaces
- ArtNet
- USB for [FX5](https://fx5.de/) and [Digital Enlightenment](http://www.digital-enlightenment.de/)
- [Custom Binary protocol via TCP/UDP](./backend/src/devices/vlight/README.md)
## Getting Started
### Using a Docker container
You can build and run this project through Docker (in a Linux container):
```
> ./docker-build.sh
> ./docker-run.sh
```
### Normal installation
Software needed:
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/lang/en/)
Build tools for native Node.js addons are also needed depending on your platform.
Install and setup:
```shellscript
> yarn
```
Start:
```shellscript
> yarn start
```
#### Windows Notes
The automatic installation of the Visual Studio Build tools does not include all features that are necessary to compile this project's addons. Find them under "Control Panel > Software / Apps & Features" and change the installation to contain the following features:
- Visual C++ ATL for x86 and x64
### Configuration
The base configuration is contained in the `config/vlight-config.js` file. It should offer documentation and auto-completion through TypeScript - otherwise, check out the [source](./backend/src/services/config.ts).
To switch projects, change the `project` setting. If you want to clone an existing project, just copy its folder inside the `config` directory.
The rest of the configuration is available in the UI:
- Fixture types are persisted globally
- All other entities and settings are persisted on a per-project basis
## Development
Start in development mode with hot reloading:
```shellscript
> yarn dev
```
### Protocols
[vLight Client Protocol via REST/WebSocket](./backend/src/services/api/README.md)
[vLight Binary Protocol via TCP/UDP](./backend/src/devices/vlight/README.md)