docs: Add GUI Configuration Tool documentation

- Added Tools Included table
- New section documenting portal_config_gui.py features
- Speed control and effect configuration details
This commit is contained in:
2026-02-21 18:36:10 +11:00
parent 13f0ae59f3
commit ebd0240dc7

View File

@@ -11,6 +11,38 @@ Designed to integrate with the [Moonlight Drive-In](https://gitea.hideawaygaming
- **Thread-safe** - Background polling thread with proper locking
- **Character database** - Built-in lookup for 80+ characters and vehicles
- **TEA encryption** - Full encryption/decryption support for character IDs
- **GUI Configuration Tool** - Visual editor for tag themes and video mappings
## Tools Included
| Tool | Description |
|------|-------------|
| `lego_dimensions_reader.py` | Core reader module and standalone test |
| `dimensions_cli_client.py` | CLI client with LED themes and video integration |
| `portal_config_gui.py` | GUI for configuring tags and themes |
| `moonlight_integration.py` | Example Moonlight Drive-In integration |
## GUI Configuration Tool
The `portal_config_gui.py` provides a visual interface for:
- **Tag Management** - View, search, and edit all configured tags
- **Theme Editor** - Set colors with RGB sliders or color picker
- **Effect Selection** - Choose Solid, Flash, or Pulse effects
- **Speed Control** - Adjust effect speed from 0.2x (fast) to 3.0x (slow)
- **Live Preview** - Test colors and effects on connected portal
- **Tag Detection** - Detect new tags and add them to config
- **Video Assignment** - Map video files to tags
```bash
python portal_config_gui.py
```
![GUI Features]
- Color picker with RGB sliders and preset colors
- Effect speed slider for Flash/Pulse animations
- Real-time portal LED preview
- JSON config file import/export
## Hardware Requirements