jankboard/README.md

24 lines
998 B
Markdown
Raw Normal View History

2024-02-21 14:19:36 -08:00
# Jankboard 2
2024-02-24 02:12:41 -08:00
A remastered version of the original Jankboard, with a focus on minimizing the Jank portion. Designed from the ground up to be easy to maintain and extend, unlike the original.
2024-02-21 19:24:24 -08:00
The frontend is powered by Svelte 4 (unfortunately, we had to drop support for the bleeding edge Svelte 5 due to lack of Vite support).
2024-02-21 14:19:36 -08:00
This project is closed source (for now) and licensed under a modified BSD 3.0 license.
2024-02-22 01:00:32 -08:00
## Current progress
2024-02-24 02:12:41 -08:00
- Basic UI layout complete
- Media player working with a few small issues
- App system working smoothly
- Camera feed likely working
- Frontend syncs basic telemetry data with robot through the same Socket-IO code that powered Jankboard v1
- Notification service installed, with Toast and audio capability
2024-02-22 01:00:32 -08:00
## TODO
- Camera cutout overlay
2024-02-24 02:12:41 -08:00
- Overhaul audio player system
- Robot visualization (3D, in Threlte).
- Overhaul backend
- Further integrate telemetry (like GPWS, collision warning, etc)
- Finish re-creating / adding various voice alerts and sequences