Skip to content

Commit ce08e27

Browse files
author
devpossible
committed
feat(docs): add new panels for warp tunnel, video, HTML, and web pages
1 parent 2884598 commit ce08e27

85 files changed

Lines changed: 3100 additions & 68 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 78 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -316,65 +316,97 @@ lcdpossible debug # Run diagnostics
316316

317317
## Available Panels
318318

319-
### System Monitoring
319+
> **Full Documentation:** See [docs/panels/README.md](docs/panels/README.md) for detailed panel documentation with screenshots.
320+
321+
### CPU
322+
323+
| Panel | Description |
324+
|-------|-------------|
325+
| [`cpu-info`](docs/core/panels/cpu-info/cpu-info.md) | Detailed CPU information including model, usage, temperature, frequency, and power |
326+
| [`cpu-usage-graphic`](docs/core/panels/cpu-usage-graphic/cpu-usage-graphic.md) | CPU usage with graphical bars including per-core breakdown |
327+
| [`cpu-usage-text`](docs/core/panels/cpu-usage-text/cpu-usage-text.md) | CPU usage displayed as large text percentage |
328+
329+
### GPU
330+
331+
| Panel | Description |
332+
|-------|-------------|
333+
| [`gpu-info`](docs/core/panels/gpu-info/gpu-info.md) | GPU information including model, usage, temperature, and VRAM |
334+
| [`gpu-usage-graphic`](docs/core/panels/gpu-usage-graphic/gpu-usage-graphic.md) | GPU usage with graphical bars |
335+
| [`gpu-usage-text`](docs/core/panels/gpu-usage-text/gpu-usage-text.md) | GPU usage displayed as large text |
336+
337+
### Media
338+
339+
| Panel | Description |
340+
|-------|-------------|
341+
| [`animated-gif:`](docs/images/panels/animated-gif/animated-gif.md) | Plays animated GIF files or URLs with full animation support |
342+
| [`image-sequence:`](docs/images/panels/image-sequence/image-sequence.md) | Plays a sequence of numbered images from a folder at 30fps |
343+
| [`video:`](docs/video/panels/video/video.md) | Plays video files, streaming URLs, or YouTube links |
344+
345+
### Memory
320346

321347
| Panel | Description |
322348
|-------|-------------|
323-
| `basic-info` | Hostname, OS, uptime |
324-
| `basic-usage-text` | CPU/RAM/GPU usage as text |
325-
| `cpu-info` | CPU model and specifications |
326-
| `cpu-usage-text` | CPU usage as text |
327-
| `cpu-usage-graphic` | CPU usage with visual bar |
328-
| `cpu-thermal-graphic` | CPU temperature gauge |
329-
| `gpu-info` | GPU model and specifications |
330-
| `gpu-usage-text` | GPU usage as text |
331-
| `gpu-usage-graphic` | GPU usage with visual bar |
332-
| `gpu-thermal-graphic` | GPU temperature gauge |
333-
| `ram-info` | RAM specifications |
334-
| `ram-usage-text` | RAM usage as text |
335-
| `ram-usage-graphic` | RAM usage with visual bar |
336-
| `network-info` | Network interface information |
337-
| `system-thermal-graphic` | Combined thermal overview |
338-
339-
### Screensavers
349+
| [`ram-info`](docs/core/panels/ram-info/ram-info.md) | Memory information including total, used, and available |
350+
| [`ram-usage-graphic`](docs/core/panels/ram-usage-graphic/ram-usage-graphic.md) | RAM usage with graphical bar |
351+
| [`ram-usage-text`](docs/core/panels/ram-usage-text/ram-usage-text.md) | RAM usage displayed as large text |
352+
353+
### Network
340354

341355
| Panel | Description |
342356
|-------|-------------|
343-
| `starfield` | Classic 3D starfield |
344-
| `matrix-rain` | Matrix-style falling characters |
345-
| `bouncing-logo` | DVD-style bouncing logo |
346-
| `mystify` | Windows Mystify lines |
347-
| `plasma` | Colorful plasma effect |
348-
| `fire` | Animated fire simulation |
349-
| `game-of-life` | Conway's Game of Life |
350-
| `bubbles` | Floating bubbles |
351-
| `rain` | Rainfall animation |
352-
| `spiral` | Hypnotic spiral |
353-
| `clock` | Digital clock display |
354-
| `noise` | TV static noise |
355-
| `warp-tunnel` | Space warp tunnel |
356-
| `pipes` | 3D pipes screensaver |
357-
| `asteroids` | Asteroids game demo |
358-
| `missile-command` | Missile Command demo |
359-
| `falling-blocks` | Tetris-style blocks |
360-
| `screensaver` | Random screensaver |
361-
362-
### Media Panels
357+
| [`network-info`](docs/core/panels/network-info/network-info.md) | Network configuration including hostname, IP addresses, gateway, and DNS |
358+
359+
### Proxmox
360+
361+
| Panel | Description |
362+
|-------|-------------|
363+
| [`proxmox-summary`](docs/proxmox/panels/proxmox-summary/proxmox-summary.md) | Proxmox cluster overview with node status and resource usage |
364+
| [`proxmox-vms`](docs/proxmox/panels/proxmox-vms/proxmox-vms.md) | List of VMs and containers with status and resource usage |
365+
366+
### Screensaver
367+
368+
| Panel | Description |
369+
|-------|-------------|
370+
| [`clock`](docs/screensavers/panels/clock/clock.md) | Analog clock with smooth second hand |
371+
| [`asteroids`](docs/screensavers/panels/asteroids/asteroids.md) | Asteroids game simulation with vector graphics |
372+
| [`bouncing-logo:`](docs/screensavers/panels/bouncing-logo/bouncing-logo.md) | Customizable text bouncing off screen edges (DVD screensaver style) with color, size, 3D, and rotation options |
373+
| [`bubbles`](docs/screensavers/panels/bubbles/bubbles.md) | Floating, bouncing translucent bubbles |
374+
| [`falling-blocks:`](docs/screensavers/panels/falling-blocks/falling-blocks.md) | Tetris-style falling blocks simulator with AI gameplay |
375+
| [`fire`](docs/screensavers/panels/fire/fire.md) | Classic demoscene fire effect with palette animation |
376+
| [`game-of-life`](docs/screensavers/panels/game-of-life/game-of-life.md) | Conway's cellular automaton with colorful patterns |
377+
| [`matrix-rain`](docs/screensavers/panels/matrix-rain/matrix-rain.md) | Digital rain effect inspired by The Matrix |
378+
| [`missile-command`](docs/screensavers/panels/missile-command/missile-command.md) | Defend cities from incoming missiles |
379+
| [`mystify`](docs/screensavers/panels/mystify/mystify.md) | Bouncing connected polygons with color trails |
380+
| [`pipes`](docs/screensavers/panels/pipes/pipes.md) | 3D pipes growing in random directions (classic Windows) |
381+
| [`plasma`](docs/screensavers/panels/plasma/plasma.md) | Classic demoscene plasma effect |
382+
| [`rain`](docs/screensavers/panels/rain/rain.md) | Falling raindrops with splash effects |
383+
| [`screensaver:`](docs/screensavers/panels/screensaver/screensaver.md) | Plays a random screensaver effect or cycles through all |
384+
| [`spiral`](docs/screensavers/panels/spiral/spiral.md) | Hypnotic rotating spiral pattern |
385+
| [`starfield`](docs/screensavers/panels/starfield/starfield.md) | Classic starfield warp effect with stars streaming from center |
386+
| [`noise`](docs/screensavers/panels/noise/noise.md) | TV static / white noise effect |
387+
| [`warp-tunnel`](docs/screensavers/panels/warp-tunnel/warp-tunnel.md) | Flying through a colorful warp tunnel |
388+
389+
### System
390+
391+
| Panel | Description |
392+
|-------|-------------|
393+
| [`basic-info`](docs/core/panels/basic-info/basic-info.md) | Basic system information including hostname, OS, and uptime |
394+
| [`basic-usage-text`](docs/core/panels/basic-usage-text/basic-usage-text.md) | Simple CPU/RAM/GPU usage summary |
395+
396+
### Thermal
363397

364398
| Panel | Description |
365399
|-------|-------------|
366-
| `animated-gif:<path\|url>` | Animated GIF playback |
367-
| `image-sequence:<folder>` | Image folder as animation |
368-
| `video:<path\|url>` | Video file, URL, or YouTube |
369-
| `html:<path>` | Render local HTML file |
370-
| `web:<url>` | Render live website |
400+
| [`cpu-thermal-graphic`](docs/core/panels/cpu-thermal-graphic/cpu-thermal-graphic.md) | CPU temperature with graphical gauge display |
401+
| [`gpu-thermal-graphic`](docs/core/panels/gpu-thermal-graphic/gpu-thermal-graphic.md) | GPU temperature with graphical gauge display |
402+
| [`system-thermal-graphic`](docs/core/panels/system-thermal-graphic/system-thermal-graphic.md) | Combined CPU and GPU temperature display with vertical thermometers |
371403

372-
### Proxmox Integration
404+
### Web
373405

374406
| Panel | Description |
375407
|-------|-------------|
376-
| `proxmox-summary` | Cluster overview with node status |
377-
| `proxmox-vms` | VM and container list |
408+
| [`html:`](docs/web/panels/html/html.md) | Renders a local HTML file using headless browser |
409+
| [`web:`](docs/web/panels/web/web.md) | Renders a live website from URL |
378410

379411
## Media Panel Examples
380412

‎docs/core/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# LCDPossible Core Panels
2+
3+
Core system information panels including CPU, GPU, RAM, and basic system info.
4+
5+
## Panels
6+
7+
| Panel | Description | Category |
8+
|-------|-------------|----------|| [Basic Info](panels/basic-info/basic-info.md) | Basic system information including hostname, OS, and uptime | System |
9+
| [Basic Usage Text](panels/basic-usage-text/basic-usage-text.md) | Simple CPU/RAM/GPU usage summary | System |
10+
| [CPU Info](panels/cpu-info/cpu-info.md) | Detailed CPU information including model, usage, temperature, frequency, and power | CPU |
11+
| [CPU Thermal](panels/cpu-thermal-graphic/cpu-thermal-graphic.md) | CPU temperature with graphical gauge display | Thermal |
12+
| [CPU Usage Graphic](panels/cpu-usage-graphic/cpu-usage-graphic.md) | CPU usage with graphical bars including per-core breakdown | CPU |
13+
| [CPU Usage Text](panels/cpu-usage-text/cpu-usage-text.md) | CPU usage displayed as large text percentage | CPU |
14+
| [GPU Info](panels/gpu-info/gpu-info.md) | GPU information including model, usage, temperature, and VRAM | GPU |
15+
| [GPU Thermal](panels/gpu-thermal-graphic/gpu-thermal-graphic.md) | GPU temperature with graphical gauge display | Thermal |
16+
| [GPU Usage Graphic](panels/gpu-usage-graphic/gpu-usage-graphic.md) | GPU usage with graphical bars | GPU |
17+
| [GPU Usage Text](panels/gpu-usage-text/gpu-usage-text.md) | GPU usage displayed as large text | GPU |
18+
| [Network Info](panels/network-info/network-info.md) | Network configuration including hostname, IP addresses, gateway, and DNS | Network |
19+
| [RAM Info](panels/ram-info/ram-info.md) | Memory information including total, used, and available | Memory |
20+
| [RAM Usage Graphic](panels/ram-usage-graphic/ram-usage-graphic.md) | RAM usage with graphical bar | Memory |
21+
| [RAM Usage Text](panels/ram-usage-text/ram-usage-text.md) | RAM usage displayed as large text | Memory |
22+
| [System Thermal](panels/system-thermal-graphic/system-thermal-graphic.md) | Combined CPU and GPU temperature display with vertical thermometers | Thermal |
23+

‎docs/core/panels/basic-info/basic-info.jpg‎

30 KB
Loading

‎docs/core/panels/basic-info/basic-info.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Basic Info
2+
3+
**Panel ID:** `basic-info`
4+
**Category:** System
5+
**Plugin:** LCDPossible Core Panels
6+
**Live Data:** Yes
7+
**Animated:** No
8+
9+
Basic system information including hostname, OS, and uptime
10+
11+
## Overview
12+
13+
The Panel: basic-info provides critical system identification details such as computer hostname, operating system name and version alongside uptime metrics essential for monitoring device performance within an enterprise environment. This straightforward functionality serves to streamline operational management by delivering real-time insights into the hardware running applications like LCDPossible without additional dependencies across various platforms.
14+
15+
## Screenshot
16+
17+
![Basic Info](basic-info.jpg)
18+
19+
## Details
20+
21+
Displays basic system identification:
22+
- Computer hostname
23+
- Operating system name and version
24+
- System uptime
25+
- Current date and time
26+
27+
No special dependencies required - works on all platforms.
28+
29+
## Examples
30+
31+
### Display basic system information
32+
33+
```bash
34+
lcdpossible show basic-info
35+
```
36+
37+
### Combine basic info with CPU usage in a slideshow
38+
39+
```bash
40+
lcdpossible show basic-info,cpu-usage-graphic
41+
```
42+
43+
44+
## Profile Usage
45+
46+
### Add to Profile
47+
48+
```bash
49+
# Add panel to default profile
50+
lcdpossible profile append-panel basic-info
51+
52+
# Add with custom duration (30 seconds)
53+
lcdpossible profile append-panel "basic-info|@duration=30"
54+
```
55+
56+
### Quick Show
57+
58+
```bash
59+
# Display panel immediately
60+
lcdpossible show basic-info
61+
```
62+
63+
---
64+
65+
*Generated by [LCDPossible](https://github.com/LCDPossible/LCDPossible)*
66+

‎docs/core/panels/basic-usage-text/basic-usage-text.jpg‎

20.6 KB
Loading

‎docs/core/panels/basic-usage-text/basic-usage-text.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Basic Usage Text
2+
3+
**Panel ID:** `basic-usage-text`
4+
**Category:** System
5+
**Plugin:** LCDPossible Core Panels
6+
**Live Data:** Yes
7+
**Animated:** No
8+
9+
Simple CPU/RAM/GPU usage summary
10+
11+
## Overview
12+
13+
The LCDPossible panel serves as an indispensable tool within system administration practices by providing administrators with a quick and comprehensive snapshot of crucial resource utilizations including CPU, RAM, and GPU percentages across the connected devices in their environment. Ideal for monitoring performance during peak operational hours or troubleshooting bottlenecks due to its real-time data presentation on one centralized interface, it stands out as an efficient solution that supports both proactive system optimization strategies and responsive reactions to unforeseen contingencies in enterprise settings.
14+
15+
## Screenshot
16+
17+
![Basic Usage Text](basic-usage-text.jpg)
18+
19+
## Details
20+
21+
Shows a compact summary of system resource usage:
22+
- CPU usage percentage
23+
- RAM usage percentage
24+
- GPU usage percentage
25+
26+
All values displayed on a single panel for quick overview.
27+
28+
## Dependencies
29+
30+
- LibreHardwareMonitorLib
31+
32+
## Examples
33+
34+
### Display combined CPU/RAM/GPU usage
35+
36+
```bash
37+
lcdpossible show basic-usage-text
38+
```
39+
40+
41+
## Profile Usage
42+
43+
### Add to Profile
44+
45+
```bash
46+
# Add panel to default profile
47+
lcdpossible profile append-panel basic-usage-text
48+
49+
# Add with custom duration (30 seconds)
50+
lcdpossible profile append-panel "basic-usage-text|@duration=30"
51+
```
52+
53+
### Quick Show
54+
55+
```bash
56+
# Display panel immediately
57+
lcdpossible show basic-usage-text
58+
```
59+
60+
---
61+
62+
*Generated by [LCDPossible](https://github.com/LCDPossible/LCDPossible)*
63+

‎docs/core/panels/cpu-info/cpu-info.jpg‎

22.1 KB
Loading

‎docs/core/panels/cpu-info/cpu-info.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# CPU Info
2+
3+
**Panel ID:** `cpu-info`
4+
**Category:** CPU
5+
**Plugin:** LCDPossible Core Panels
6+
**Live Data:** Yes
7+
**Animated:** No
8+
9+
Detailed CPU information including model, usage, temperature, frequency, and power
10+
11+
## Overview
12+
13+
The LCDPossible cpu-info panel delivers precise and up-to-date details regarding CPU performance metrics such as model specifics, current utilization rates, operational temperatures (when equipped with sensors), clock frequencies, and power usage figures when available. It is primarily designed to assist system administrators in monitoring hardware efficiency directly from the command line interface or through integration into larger management systems, thus facilitating informed decisions for optimizing system performance and maintenance schedules within corporate environments.
14+
15+
## Screenshot
16+
17+
![CPU Info](cpu-info.jpg)
18+
19+
## Details
20+
21+
Displays comprehensive CPU information in a formatted layout:
22+
- CPU model name and architecture
23+
- Current usage percentage
24+
- Temperature (if sensors available)
25+
- Clock frequency
26+
- Power consumption (if available)
27+
28+
Requires LibreHardwareMonitor for Windows sensor data.
29+
30+
## Dependencies
31+
32+
- LibreHardwareMonitorLib
33+
34+
## Examples
35+
36+
### Display CPU information panel
37+
38+
```bash
39+
lcdpossible show cpu-info
40+
```
41+
42+
### Display CPU info for 30 seconds
43+
44+
```bash
45+
lcdpossible show cpu-info|@duration=30
46+
```
47+
48+
49+
## Profile Usage
50+
51+
### Add to Profile
52+
53+
```bash
54+
# Add panel to default profile
55+
lcdpossible profile append-panel cpu-info
56+
57+
# Add with custom duration (30 seconds)
58+
lcdpossible profile append-panel "cpu-info|@duration=30"
59+
```
60+
61+
### Quick Show
62+
63+
```bash
64+
# Display panel immediately
65+
lcdpossible show cpu-info
66+
```
67+
68+
---
69+
70+
*Generated by [LCDPossible](https://github.com/LCDPossible/LCDPossible)*
71+

‎docs/core/panels/cpu-thermal-graphic/cpu-thermal-graphic.jpg‎

21.5 KB
Loading

0 commit comments

Comments
 (0)