Skip to content

Commit a554aee

Browse files
author
devpossible
committed
Merge remote-tracking branch 'origin/dependabot/nuget/src/LCDPossible.Sdk/SixLabors.ImageSharp.Drawing-2.1.7' into develop
2 parents 1040217 + 4cb8bf0 commit a554aee

48 files changed

Lines changed: 4402 additions & 1635 deletions

Some content is hidden

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

‎CHANGELOG.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717

1818
## [Unreleased]
1919

20+
### Added
21+
22+
- **Page Effects System** - 30+ animated overlays for panels:
23+
- Background effects: aurora, snow, rain, bubbles, fireflies, stars-twinkle, lava-lamp, bokeh, smoke, waves, confetti, lightning, clouds, embers, fireworks, breathing-glow
24+
- Overlay effects: vhs-static, film-grain, lens-flare, neon-border, chromatic-aberration, crt-warp
25+
- Container animations: gentle-float, tilt-3d, bounce, wave
26+
- Character mascots: vanna-white, pixel-mascot, robot-assistant
27+
- Alert effects: spotlight
28+
- **Effects Documentation** - New `docs/effects/README.md` with usage guide
29+
30+
### Changed
31+
32+
- Slowed down matrix-rain effect speed for better visibility
33+
- Slowed down grid-pulse effect speed for smoother animation
34+
35+
### Removed
36+
37+
- Removed value-change triggered effects (particle-burst, glitch, glow-on-change, flip-digits, typewriter, slide-numbers, neon-trails, shake-on-warning, warning-flash, bounce-in)
38+
- Removed color-cycle effect
39+
- Removed red-man effect
40+
2041
## [0.3.0] - 2026-01-11
2142

2243
## [0.2.5] - 2026-01-11

‎CLAUDE.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,61 @@ lcdpossible config list-themes
300300
lcdpossible show cpu-info|@theme=executive
301301
```
302302

303+
## Available Page Effects
304+
305+
For complete effects documentation, see `docs/effects/README.md`.
306+
307+
Page effects are animated overlays applied to panels. Apply with `|@effect=<name>`.
308+
309+
### Background Effects
310+
311+
| Effect | Description |
312+
|--------|-------------|
313+
| `scanlines` | CRT/retro scanline overlay |
314+
| `matrix-rain` | Digital rain falling behind widgets |
315+
| `particle-field` | Floating particles in the background |
316+
| `grid-pulse` | Grid lines pulse outward from center |
317+
| `fireworks` | Colorful fireworks exploding |
318+
| `aurora` | Northern lights with flowing color ribbons |
319+
| `snow` | Gentle snowflakes drifting down |
320+
| `rain` | Rain drops falling with splash effects |
321+
| `bubbles` | Translucent bubbles floating upward |
322+
| `fireflies` | Glowing particles drifting randomly |
323+
| `stars-twinkle` | Stationary twinkling starfield |
324+
| `lava-lamp` | Blobby colored blobs floating |
325+
| `bokeh` | Out-of-focus light circles drifting |
326+
| `smoke` | Wispy smoke tendrils rising |
327+
| `waves` | Ocean waves flowing at bottom |
328+
| `confetti` | Colorful confetti falling |
329+
| `lightning` | Occasional lightning flashes |
330+
| `clouds` | Slow-moving clouds drifting |
331+
| `embers` | Glowing embers floating upward |
332+
| `breathing-glow` | Pulsing ambient glow around edges |
333+
334+
### Overlay Effects
335+
336+
| Effect | Description |
337+
|--------|-------------|
338+
| `vhs-static` | VHS tape noise/tracking lines |
339+
| `film-grain` | Old film grain texture overlay |
340+
| `lens-flare` | Moving lens flare effect |
341+
| `neon-border` | Glowing pulse around widget edges |
342+
| `chromatic-aberration` | RGB split/shift effect |
343+
| `crt-warp` | CRT screen edge warping |
344+
345+
### Effect Usage
346+
347+
```bash
348+
# Apply effect to panel
349+
lcdpossible show cpu-status|@effect=matrix-rain
350+
351+
# Combine with theme
352+
lcdpossible show cpu-status|@effect=scanlines|@theme=cyberpunk
353+
354+
# Random effect
355+
lcdpossible show cpu-status|@effect=random
356+
```
357+
303358
### Media Panel Examples
304359

305360
```bash

‎SECURITY.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We release patches for security vulnerabilities for the following versions:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 0.8.x | :white_check_mark: |
10+
| < 0.8 | :x: |
11+
12+
## Reporting a Vulnerability
13+
14+
We take the security of LCDPossible seriously. If you believe you have found a security vulnerability, please report it to us as described below.
15+
16+
**Please do not report security vulnerabilities through public GitHub issues.**
17+
18+
### How to Report
19+
20+
1. **GitHub Security Advisories**: Use the [GitHub Security Advisories](https://github.com/DevPossible/LCDPossible/security/advisories/new) feature (preferred)
21+
2. **Email**: Contact the maintainers via GitHub discussions or create a private security advisory
22+
23+
### What to Include
24+
25+
Please include as much of the following information as possible:
26+
27+
- Type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
28+
- Full paths of source file(s) related to the manifestation of the issue
29+
- The location of the affected source code (tag/branch/commit or direct URL)
30+
- Any special configuration required to reproduce the issue
31+
- Step-by-step instructions to reproduce the issue
32+
- Proof-of-concept or exploit code (if possible)
33+
- Impact of the issue, including how an attacker might exploit it
34+
35+
### Response Timeline
36+
37+
- We will acknowledge receipt of your vulnerability report within 3 business days
38+
- We will send a more detailed response within 7 days indicating next steps
39+
- We will keep you informed of the progress towards a fix
40+
- We will notify you when the vulnerability is fixed
41+
42+
## Security Best Practices for Users
43+
44+
### Configuration Files
45+
46+
- **Never commit sensitive data** to version control:
47+
- Use environment variables or local config files (*.Local.json)
48+
- These are excluded by .gitignore: `*.env`, `secrets.json`, `appsettings.*.Local.json`
49+
50+
### Proxmox API Integration
51+
52+
- **Use API tokens** instead of username/password authentication
53+
- **Create read-only tokens** with minimal required permissions
54+
- **Use SSL/TLS** for API connections (disable `IgnoreSslErrors` only for testing with self-signed certificates)
55+
- **Rotate tokens regularly** as part of good security hygiene
56+
57+
### File Permissions
58+
59+
- On Linux/macOS, ensure configuration files have appropriate permissions:
60+
```bash
61+
chmod 600 /etc/lcdpossible/appsettings.json
62+
```
63+
64+
### Running as a Service
65+
66+
- **Windows**: The service runs under LocalSystem by default. Consider using a dedicated service account
67+
- **Linux**: Use systemd with a dedicated user account (not root)
68+
- **macOS**: Use launchd with a dedicated user account
69+
70+
## Known Security Considerations
71+
72+
### USB Device Access
73+
74+
LCDPossible requires direct USB HID device access:
75+
- **Linux**: Requires udev rules for unprivileged access (see installation documentation)
76+
- **Windows**: Requires administrator privileges for first-time device access
77+
- **macOS**: May require Security & Privacy settings adjustment
78+
79+
### LibVLC Integration
80+
81+
The video panel feature uses LibVLC for media playback:
82+
- Keep LibVLC updated to receive security patches
83+
- Be cautious when playing untrusted media files or streams
84+
85+
### Web Panel
86+
87+
The web panel uses PuppeteerSharp (headless browser):
88+
- Be cautious when rendering untrusted web content
89+
- Network-isolated environments are recommended for displaying external websites
90+
91+
## Secure Development
92+
93+
### For Contributors
94+
95+
- Never commit secrets or credentials to the repository
96+
- Use the provided .gitignore patterns
97+
- Mask sensitive data in logs and CLI output
98+
- Validate and sanitize all external inputs
99+
- Follow principle of least privilege for API integrations
100+
- Use parameterized queries if database access is added in the future
101+
102+
### Code Review Checklist
103+
104+
- [ ] No hardcoded credentials or API keys
105+
- [ ] Sensitive data properly masked in logs
106+
- [ ] Input validation and sanitization
107+
- [ ] Proper error handling (no information leakage)
108+
- [ ] Dependencies checked for known vulnerabilities
109+
- [ ] SSL/TLS used for network communication
110+
- [ ] Proper resource disposal (IDisposable pattern)
111+
112+
## Security Updates
113+
114+
Security updates are released as soon as possible after a vulnerability is confirmed. We recommend:
115+
116+
- Subscribe to GitHub release notifications
117+
- Enable Dependabot alerts for your fork
118+
- Keep LCDPossible updated to the latest version
119+
120+
## Acknowledgments
121+
122+
We appreciate the security research community's efforts to help keep LCDPossible secure. Responsible disclosure helps protect all users.

‎docs/effects/README.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# LCDPossible Page Effects
2+
3+
Page effects are animated overlays that can be applied to any panel to add visual flair. Effects run in real-time and are rendered on top of or behind the panel content.
4+
5+
**Related Documentation:**
6+
- [Panels](../panels/README.md) - Available display panels
7+
- [Themes](../themes/README.md) - Color themes and customization
8+
9+
## Using Effects
10+
11+
### Apply Effect to Panel
12+
13+
```bash
14+
# Apply effect using pipe syntax
15+
lcdpossible show cpu-status|@effect=matrix-rain
16+
17+
# Multiple modifiers
18+
lcdpossible show cpu-status|@effect=scanlines|@theme=cyberpunk
19+
20+
# In profile YAML
21+
panels:
22+
- type: cpu-status
23+
effect: aurora
24+
theme: cyberpunk
25+
```
26+
27+
### Random Effect
28+
29+
```bash
30+
# Apply random effect
31+
lcdpossible show cpu-status|@effect=random
32+
```
33+
34+
## Effect Categories
35+
36+
### Container Animation Effects
37+
38+
Effects that animate the panel widgets/containers.
39+
40+
| Effect | Description |
41+
|--------|-------------|
42+
| `gentle-float` | Containers float up/down subtly (breathing effect) |
43+
| `tilt-3d` | Containers have slight 3D tilt/perspective that shifts |
44+
| `bounce` | Widgets bounce around with physics, bouncing off walls |
45+
| `wave` | Widgets wave in a sine pattern across the grid |
46+
47+
### Background Effects
48+
49+
Animated backgrounds that render behind the panel content.
50+
51+
| Effect | Description |
52+
|--------|-------------|
53+
| `scanlines` | CRT/retro scanline overlay |
54+
| `matrix-rain` | Digital rain falling behind widgets |
55+
| `particle-field` | Floating particles in the background |
56+
| `grid-pulse` | Grid lines pulse outward from center |
57+
| `fireworks` | Colorful fireworks exploding in the background |
58+
| `hologram` | Holographic shimmer/interference pattern |
59+
| `aurora` | Northern lights with flowing color ribbons |
60+
| `snow` | Gentle snowflakes drifting down |
61+
| `rain` | Rain drops falling with splash effects |
62+
| `bubbles` | Translucent bubbles floating upward |
63+
| `fireflies` | Glowing particles drifting randomly |
64+
| `stars-twinkle` | Stationary twinkling starfield |
65+
| `lava-lamp` | Blobby colored blobs floating |
66+
| `bokeh` | Out-of-focus light circles drifting |
67+
| `smoke` | Wispy smoke tendrils rising |
68+
| `waves` | Ocean waves flowing at bottom |
69+
| `confetti` | Colorful confetti falling continuously |
70+
| `lightning` | Occasional lightning flashes across background |
71+
| `clouds` | Slow-moving clouds drifting across |
72+
| `embers` | Glowing embers floating upward |
73+
| `breathing-glow` | Pulsing ambient glow around edges |
74+
75+
### Overlay Effects
76+
77+
Effects that render on top of panel content for post-processing looks.
78+
79+
| Effect | Description |
80+
|--------|-------------|
81+
| `vhs-static` | VHS tape noise/tracking lines |
82+
| `film-grain` | Old film grain texture with scratches |
83+
| `lens-flare` | Moving lens flare effect |
84+
| `neon-border` | Glowing pulse around widget edges |
85+
| `chromatic-aberration` | RGB split/shift effect at edges |
86+
| `crt-warp` | CRT screen edge warping/vignette |
87+
88+
### Character/Mascot Effects
89+
90+
Animated characters that interact with the panel content.
91+
92+
| Effect | Description |
93+
|--------|-------------|
94+
| `vanna-white` | Character walks up to tiles and gestures at them |
95+
| `pixel-mascot` | Retro pixel character reacts to values |
96+
| `robot-assistant` | Cute robot points at important metrics |
97+
98+
### Alert/Status Effects
99+
100+
Effects triggered by panel state or data values.
101+
102+
| Effect | Description |
103+
|--------|-------------|
104+
| `spotlight` | Roaming spotlight illuminates different widgets |
105+
106+
## Effect Details
107+
108+
### aurora
109+
110+
Northern lights effect with flowing color ribbons across the screen.
111+
112+
- **Category:** Background
113+
- **Performance:** Medium (canvas animation)
114+
- **Best with:** Dark themes, space/tech panels
115+
116+
### matrix-rain
117+
118+
Digital rain effect inspired by The Matrix. Green characters fall from top to bottom.
119+
120+
- **Category:** Background
121+
- **Performance:** Medium (canvas animation)
122+
- **Best with:** Cyberpunk theme, system monitoring panels
123+
124+
### scanlines
125+
126+
Classic CRT scanline overlay for a retro computing aesthetic.
127+
128+
- **Category:** Background
129+
- **Performance:** Low (CSS only)
130+
- **Best with:** Any dark theme, retro look
131+
132+
### vhs-static
133+
134+
VHS tape playback simulation with static noise, tracking lines, and occasional tears.
135+
136+
- **Category:** Overlay
137+
- **Performance:** Medium (canvas animation)
138+
- **Best with:** Retro themes, video panels
139+
140+
### film-grain
141+
142+
Old film grain texture with scratches and dust spots for a vintage cinema look.
143+
144+
- **Category:** Overlay
145+
- **Performance:** Medium (canvas animation)
146+
- **Best with:** Any theme, adds texture
147+
148+
### chromatic-aberration
149+
150+
RGB color channel separation effect at screen edges, simulating lens distortion.
151+
152+
- **Category:** Overlay
153+
- **Performance:** Low (CSS transforms)
154+
- **Best with:** Cyberpunk theme, tech panels
155+
156+
### lava-lamp
157+
158+
Colorful blobs that float and merge like a lava lamp.
159+
160+
- **Category:** Background
161+
- **Performance:** Medium (canvas animation)
162+
- **Best with:** RGB gaming theme, casual displays
163+
164+
### confetti
165+
166+
Celebratory confetti particles falling continuously.
167+
168+
- **Category:** Background
169+
- **Performance:** Medium (canvas animation)
170+
- **Best with:** Achievement displays, celebrations
171+
172+
---
173+
174+
*Generated by [LCDPossible](https://github.com/DevPossible/LCDPossible)*

‎docs/panels/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This directory contains documentation and screenshots for all available display
44

55
**Related Documentation:**
66
- [Themes](../themes/README.md) - Available color themes and customization
7+
- [Page Effects](../effects/README.md) - Animated overlays and backgrounds
78

89
## Panel Categories
910

0 commit comments

Comments
 (0)