Welcome to the LCDPossible documentation. LCDPossible is a cross-platform LCD controller service for HID-based LCD screens.
| Section | Description |
|---|---|
| Getting Started | Installation and first steps |
| Virtual LCD Simulator | Test without hardware |
| Panels | Available display panels |
| Effects | Page effects and animations |
| Themes | Color themes and customization |
| Configuration | Profiles, settings, and service setup |
| CLI Reference | Command-line interface |
| Plugin Development | Creating custom panels and device drivers |
| Technical Reference | Architecture, protocols, and internals |
| Troubleshooting | Common issues and solutions |
docs/
├── getting-started.md # Installation & quick start
├── configuration/ # Profiles, settings, service setup
├── cli/ # Command-line reference
├── panels/ # Panel documentation
│ ├── system/ # CPU, GPU, RAM, Network panels
│ ├── media/ # Video, GIF, Images, Web panels
│ ├── screensavers/ # Screensaver panels
│ └── integrations/ # Proxmox and other integrations
├── effects/ # Page effects
├── themes/ # Color themes
├── plugins/ # Plugin development guide
├── reference/ # Technical reference
│ ├── devices/ # USB device protocols
│ └── architecture.md # System architecture
├── troubleshooting.md # Common issues
└── examples/ # Example configurations
- New to LCDPossible? Start with Getting Started
- No hardware yet? Try the Virtual LCD Simulator to test without a device
- Want to customize your display? See Panels, Effects, and Themes
- Setting up as a service? Check Configuration
- Creating custom panels? See Plugin Development
- Adding device support? See Creating Device Drivers
- Understanding the codebase? See Architecture
LCDPossible - Open source LCD controller