diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index 38d85ea..76be075 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -2,15 +2,24 @@ This document outlines the planned feature development for Weevil across multiple versions. Features are subject to change based on user feedback, technical constraints, and market needs. +## Status Key + +- ✅ **Complete** - Feature shipped in a release +- ⚠️ **In Progress** - Currently being developed +- 🔄 **Deferred** - Planned but postponed to a later version +- ❌ **Cancelled** - Feature dropped from roadmap + --- -## Version 1.1.0 - Core Stability & Team Adoption +## Version 1.1.0 - Core Stability & Team Adoption ✅ COMPLETE **Theme:** Making Weevil production-ready for FTC teams with essential operational features and reducing friction in existing workflows. -### System Audit & Diagnostics +**Status:** Released as v1.1.0-beta.2 (pending Windows testing) -**Feature:** `weevil status` or `weevil doctor` command +### System Audit & Diagnostics ✅ + +**Feature:** `weevil doctor` command **Description:** Provides a comprehensive audit of the development environment, showing what's installed and what versions are present. This would display: - FTC SDK versions (current and available) @@ -20,6 +29,8 @@ This document outlines the planned feature development for Weevil across multipl - ADB availability and version - Any other critical dependencies Weevil manages +**Status:** ✅ Complete - Shipped in v1.1.0 + **Rationale:** Teams need visibility into their environment to troubleshoot issues. Coaches working with multiple machines need to quickly verify setup consistency across laptops. This builds trust by making Weevil's actions transparent. **Pros:** @@ -33,13 +44,11 @@ This document outlines the planned feature development for Weevil across multipl - Version detection across platforms may be fragile - Output formatting needs to be clear for non-technical users -**Priority:** HIGH - Essential for v1.1.0 - --- -### Dependency Cleanup +### Dependency Cleanup ✅ -**Feature:** `weevil clean` or `weevil uninstall` command +**Feature:** `weevil uninstall` command **Description:** Removes dependencies that Weevil installed during setup. This includes: - FTC SDK files @@ -47,7 +56,9 @@ This document outlines the planned feature development for Weevil across multipl - Gradle distributions - Configuration files Weevil created -Should offer options for selective cleanup (e.g., keep SDK but remove Gradle) or complete removal. +Offers options for selective cleanup (e.g., keep SDK but remove Gradle) or complete removal. + +**Status:** ✅ Complete - Shipped in v1.1.0 **Rationale:** Teams switch machines, need to free disk space, or want to start fresh. Without a clean uninstall, Weevil leaves artifacts behind. This is critical for maintaining system hygiene and building confidence that Weevil doesn't pollute the environment. @@ -61,11 +72,9 @@ Should offer options for selective cleanup (e.g., keep SDK but remove Gradle) or - Risk of removing shared dependencies other tools need - Need careful confirmation prompts to prevent accidental deletion -**Priority:** HIGH - Essential for v1.1.0 - --- -### Corporate/School Proxy Support +### Corporate/School Proxy Support ✅ **Feature:** Transparent proxy configuration for all network operations @@ -77,6 +86,10 @@ Should offer options for selective cleanup (e.g., keep SDK but remove Gradle) or Handle `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` environment variables and write appropriate configuration into Gradle properties, Android SDK manager config, etc. +**Status:** ✅ Complete - Shipped in v1.1.0 + +**Implementation:** `--proxy ` and `--no-proxy` global flags, automatic HTTPS_PROXY/HTTP_PROXY env var detection + **Rationale:** Many FTC teams work in schools or corporate environments with mandatory proxy servers. Without proxy support, Weevil is unusable in these environments, cutting off a significant portion of the potential user base. **Pros:** @@ -90,11 +103,9 @@ Handle `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` environment variables and write a - SSL/certificate issues in corporate environments - Testing requires access to proxy environments -**Priority:** HIGH - Essential for v1.1.0 - --- -### Android Studio Integration +### Android Studio Integration ✅ **Feature:** Seamless integration with Android Studio IDE @@ -103,10 +114,15 @@ Handle `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` environment variables and write a - Present a clean, minimal file tree to students - Hook Weevil's build and deploy scripts into Android Studio's "Run" button - Properly configure the IDE's indexing and code completion -- Support debugging integration The goal: students work in Android Studio (the tool they know) but get Weevil's improved project structure and deployment workflow behind the scenes. +**Status:** ✅ Complete - Shipped in v1.1.0-beta.2 + +**Implementation:** Auto-generated `.idea/` run configurations (Build, Deploy auto/USB/WiFi, Test), workspace.xml for clean file tree, cross-platform support (Unix .sh and Windows .bat variants) + +**Note:** Requires Shell Script plugin installation in Android Studio (documented in README) + **Rationale:** This is the killer feature that bridges the gap between Weevil's better engineering practices and students' existing workflow. Kids already know Android Studio. Making Weevil "just work" with it removes adoption friction and lets them focus on robot code, not tooling. **Pros:** @@ -116,16 +132,14 @@ The goal: students work in Android Studio (the tool they know) but get Weevil's - Makes Weevil invisible in the best way - it just works **Cons:** -- Android Studio project file format may change +- Android Studio project file format may change between versions - Complex to test across different Android Studio versions - May conflict with students' existing Android Studio customizations -- Requires deep understanding of IDE configuration - -**Priority:** HIGH - Strong candidate for v1.1.0 (killer feature) +- Requires Shell Script plugin (one-time setup) --- -### Manual Installation Fallback Documentation +### Manual Installation Fallback Documentation 🔄 **Feature:** Comprehensive manual setup documentation @@ -136,6 +150,8 @@ The goal: students work in Android Studio (the tool they know) but get Weevil's - Checksums for verifying downloads - Fallback download URLs if primary sources are blocked +**Status:** 🔄 Deferred to v1.2.0 - Basic troubleshooting exists in README, comprehensive guide pending + **Rationale:** Automation fails. Proxies block downloads. Firewalls interfere. Having a "guaranteed to work" manual path builds confidence and ensures teams aren't stuck. This is about providing an escape hatch and building trust. **Pros:** @@ -149,11 +165,9 @@ The goal: students work in Android Studio (the tool they know) but get Weevil's - Screenshots go stale quickly - Platform variations multiply documentation burden -**Priority:** MEDIUM-HIGH - Strong candidate for v1.1.0 - --- -### Package Distribution (Debian/Ubuntu) +### Package Distribution (Debian/Ubuntu) 🔄 **Feature:** `.deb` package for easy installation on Debian-based systems @@ -163,6 +177,8 @@ The goal: students work in Android Studio (the tool they know) but get Weevil's - Handle any system dependencies - Support clean uninstallation +**Status:** 🔄 Deferred - Not essential for initial adoption + **Rationale:** Provides a "professional" distribution method for Linux users. Makes Weevil feel like real software, not just a script. Easier for schools/teams to deploy across multiple machines. **Pros:** @@ -177,14 +193,76 @@ The goal: students work in Android Studio (the tool they know) but get Weevil's - Most teams will just download the binary anyway - Not essential for functionality -**Priority:** LOW - Nice to have, but not essential for v1.1.0 - --- ## Version 1.2.0 - Polish & Accessibility **Theme:** Making Weevil accessible to non-technical users and expanding platform support. +**Status:** Planning + +### Android Studio Debugging Support + +**Feature:** Full debugging integration for Android Studio + +**Description:** Extend the Android Studio integration to support breakpoint debugging directly from the IDE: +- Generate debug run configurations that attach to the robot +- Configure remote debugging for Android/FTC apps +- Map source files correctly for breakpoint support +- Handle ADB debugging bridge setup automatically +- Support both USB and WiFi debugging + +Students should be able to: +1. Set breakpoints in their OpMode code +2. Select "Debug" configuration from Android Studio +3. Click the debug button (🐛) +4. Have the debugger attach to the running robot +5. Step through code, inspect variables, etc. + +**Rationale:** Debugging is a critical skill, and print-statement debugging (`telemetry.addData()`) is primitive. Teaching students to use a real debugger makes them better engineers. This feature positions Weevil as a complete development environment, not just a build tool. + +**Pros:** +- Massive educational value - teaches proper debugging +- Competitive advantage (official SDK doesn't make this easy) +- Natural extension of existing Android Studio integration +- Students already familiar with debuggers from other IDEs + +**Cons:** +- Android debugging setup is complex (ADB, JDWP, remote attach) +- WiFi debugging is finicky and may be unreliable +- Debugging autonomous modes has timing implications +- Requires deep understanding of Android debug protocol +- May not work reliably on all Control Hub firmware versions + +**Priority:** HIGH - Natural next step after basic Android Studio integration + +**Technical Notes:** +- Need to generate Android Studio remote debug configurations +- May require modifications to deploy scripts to enable debug mode +- JDWP (Java Debug Wire Protocol) over ADB +- Consider "Debug (USB)" and "Debug (WiFi)" separate configurations + +--- + +### Windows Testing & Stabilization + +**Feature:** Complete Windows support verification + +**Description:** Comprehensive testing of all v1.1.0 features on Windows 10 and Windows 11: +- Proxy support with Windows-specific quirks +- Android Studio integration with Windows paths +- Build and deployment scripts (`.bat` files) +- Gradle wrapper on Windows +- Path handling (backslashes vs. forward slashes) + +**Status:** Required before v1.1.0 final release + +**Rationale:** Many FTC teams use Windows. Can't ship v1.1.0 final without Windows verification. + +**Priority:** CRITICAL - Blocks v1.1.0 final release + +--- + ### Windows Installer (MSI) **Feature:** Professional Windows installer package @@ -196,6 +274,8 @@ The goal: students work in Android Studio (the tool they know) but get Weevil's - Appears in "Programs and Features" for clean uninstall - Optionally creates desktop shortcut +**Status:** Planned for v1.2.0 + **Rationale:** Windows users expect installers, not loose executables. An MSI makes Weevil feel professional and legitimate. Start menu integration makes it discoverable. **Pros:** @@ -562,7 +642,40 @@ This makes adding new languages easier and keeps core clean. ## Unscheduled / Research Needed +### SOCKS Proxy Support + +**Feature:** Support for SOCKS4/SOCKS5 proxies in addition to HTTP proxies + +**Description:** Extend proxy support to handle SOCKS proxies, which are common in certain corporate and academic environments: +- Auto-detect SOCKS proxy from environment variables +- Support SOCKS4, SOCKS5, and SOCKS5h protocols +- Handle authentication if required +- Configure all network operations (Gradle, SDK downloads, Git) to use SOCKS + +**Status:** Research - needs market validation + +**Rationale:** Some environments use SOCKS proxies instead of HTTP proxies. While HTTP proxy support covers most cases, SOCKS support would enable Weevil in additional restricted environments. + +**Pros:** +- Broader environment support +- Some corporate networks mandate SOCKS +- Demonstrates thoroughness + +**Cons:** +- More complex than HTTP proxy (different protocols) +- Smaller user base than HTTP proxy +- Not all tools (Gradle, Git) support SOCKS equally well +- May require native library integration (e.g., libcurl with SOCKS support) +- Authentication adds complexity + +**Priority:** LOW - HTTP proxy covers most use cases + +**Decision Point:** Wait for user requests. If teams need SOCKS support, prioritize accordingly. + +--- + ### Cloud Build Services + **Description:** Remote build servers for teams with slow computers. Teams push code, Weevil builds in the cloud, streams back APK. **Status:** Research - needs cost/benefit analysis, infrastructure planning @@ -570,6 +683,7 @@ This makes adding new languages easier and keeps core clean. --- ### VS Code Extension + **Description:** Extension for VS Code to provide similar integration as Android Studio. **Status:** Research - depends on VS Code adoption in FTC community @@ -577,6 +691,7 @@ This makes adding new languages easier and keeps core clean. --- ### Team Collaboration Features + **Description:** Features for teams to coordinate across multiple developers - shared configurations, code review integration, task tracking. **Status:** Research - needs market validation (do teams want this?) @@ -584,6 +699,7 @@ This makes adding new languages easier and keeps core clean. --- ### Custom Hardware Support + **Description:** Templates and tools for teams using custom sensors or actuators beyond standard FTC parts. **Status:** Research - depends on community need @@ -624,4 +740,4 @@ Features may be accelerated, deferred, or cancelled as the project evolves. --- -*Last Updated: January 2026* \ No newline at end of file +*Last Updated: February 2026* \ No newline at end of file