update project docs with grid rewrite, 3d shader, preset system, and key implementation details

This commit is contained in:
Eric Smith 2026-05-20 16:20:58 -04:00
parent 9cbb54cc39
commit 9adba9d6c2
2 changed files with 54 additions and 4 deletions

View file

@ -9,7 +9,9 @@ V Panel is a visually rich, real-time status monitoring dashboard built entirely
## Features
- **Responsive grid dashboard** — Modules auto-arrange in a dynamic grid that adapts to window size. Drag-and-drop to rearrange.
- **Shader-based vial fill** — Each module uses a custom `vial_fill.gdshader` instead of progress bars. Features sum-of-sines water surface animation, edge-damped meniscus, wave distortion, ripple rings, swirl, HSV colour shifting, top-down lighting, sparkle effects, and a foam surface line.
- **Variable-size modules** — Modules can span multiple grid cells (1×1, 2×1, 2×2, etc.). Drag edges/corners to resize interactively.
- **Shader-based vial fill** — Each module uses a custom `vial_fill.gdshader` instead of progress bars. Features sum-of-sines water surface with edge-damped meniscus, wave distortion, ripple rings, swirl, HSV colour shifting, top-down lighting, sparkle effects, 3D subsurface scattering, gaussian surface foam, and wave-slope specular highlights.
- **Shader preset system** — Double-click any module to open a popup menu with 7 visual presets (Vivid Vial, Emerald Deep, Lava Flow, Neon Dream, Deep Purple, Rainbow Swirl, Frostbite). Presets control all visual shader parameters.
- **Live system monitoring** — Reads CPU usage from `/proc/stat` and memory usage from `/proc/meminfo` on Linux. Extensible module system for adding new collectors.
- **Smooth animations** — All fill level transitions use tweens with cubic easing.
@ -21,9 +23,15 @@ V Panel is a visually rich, real-time status monitoring dashboard built entirely
| Memory | `/proc/meminfo` | Real-time memory usage percentage |
| Testing | N/A (cycles 0100%) | Shader visual testing with stepped fill levels |
## Controls
- **Drag module** — Click and drag to rearrange modules on the grid
- **Resize module** — Click and drag any edge or corner to resize (snaps to cell grid)
- **Shader presets** — Double-click a module to open the preset selection popup
## Project Status
Active development. Core framework, drag-and-drop, CPU/memory collectors, and shader-based vial fill are implemented. More system modules (disk, network) are planned.
Active development. Core framework, drag-and-drop with resize, CPU/memory collectors, shader-based vial fill with 3D surface effects, and preset system are implemented. More system modules (disk, network) are planned.
## License