From 3bde63db028a3f183d8cfce8f8576955084e51dd Mon Sep 17 00:00:00 2001 From: Youwen Wu <38934577+couscousdude@users.noreply.github.com> Date: Mon, 26 Feb 2024 22:50:14 -0800 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 97a3086..e88e829 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,23 @@ A remastered version of the original Jankboard, with a focus on minimizing the J 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). This project is closed source (for now) and licensed under a modified BSD 3.0 license. -## Current progress +## Current progress and improvements over (original) Jankboard -- 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 +- Layout, toasts/notifications, music player, and app system ported. +- Toast and audio cue system is much more robust +- Transitions added almost everywhere to make things smoother +- Tauri app created successfully, currently still using Flask backend +- Visualization vastly improved with Threlte (Three.js) powered 3D robot simulation +- Robot model ported successfully via massive optimization through polygon decimation +- Added settings app with options to disable certain features and developer tools for testing ## TODO - Camera cutout overlay - Overhaul audio player system -- Robot visualization (3D, in Threlte). -- Overhaul backend +- Overhaul visualization (especially camera) +- Overhaul backend in Rust - Further integrate telemetry (like GPWS, collision warning, etc) - Finish re-creating / adding various voice alerts and sequences +- Create dynamic voice prompt system to support new languages very easily +- Add dynamic voice prompt fallback to support incremental voice prompt migration