FRC Framework

FRC Framework 是由 0.2Studio 开发的跨平台 FRC Java 项目工作台。它使用可视化结构维护 project.yaml，同时生成清晰、普通、可以脱离本软件继续开发的 WPILib Java 代码。

界面支持简体中文和英文，桌面版本支持 Windows、macOS 与 Linux。

主要功能

• 创建或打开 WPILib 2026 Command-Based 项目；没有 project.yaml 时可从 Java 源码保守导入。
• 可视化维护 Subsystem、Mechanism、设备、CAN ID、参数、Command、控制器绑定和 Auto。
• IronPulse 设备目录提供参数说明、真实硬件/仿真实现和默认 NetworkTables 调参入口。
• Base 内置精简、可独立构建的 IronPulse 风格支持层；电机参数和兼容方法已按本地 10541 赛季代码校准，并包含 Beam Break、手柄震动和常用布尔工具。
• Swerve、Limelight、Flywheel、Position Mechanism、Indexer、LED 等开箱即用预制模块。
• 以真实目录层级浏览 Java、Kotlin、C/C++、Gradle、PathPlanner、配置、脚本、文档、模型和日志等项目文件；二进制文件不会被当作文本读取。
• 监听外部源码修改并增量更新 Subsystem、Goal、Device、Controller、Binding、Command 与 Auto；手写结构明确只读，受管理区域冲突时要求人工确认。
• 所有结构化修改先显示文件 Diff，再以事务方式写入 YAML、Java 与英文机器人文档。
• 支持 NT4 参数比较与回写、WPILib 构建/测试/仿真/部署以及外部 IDE、PathPlanner、AdvantageScope。

概念速览

• Subsystem：WPILib 调度和资源 ownership 的顶层功能系统，例如 Shooter 或 Swerve。
• Mechanism：Subsystem 内部的物理功能单元，例如 Shooter Upper、Shooter Lower、Arm Pivot 或一个 Swerve Module。每个 Mechanism 都有自己的 Java 文件、直接设备、Goal 和局部命令；任意深度都遵循同一规则。
• Config：有电机的节点会生成相邻的 <Node>Config.java，专门保存 CAN、反向、PID/前馈、限位、归零与仿真配置；<Node>.java 保持为 Goal、Default Command 和运行逻辑。
• Device：具体电机、编码器、陀螺仪、传感器或相机。
• Goal：Subsystem 想达到的目标状态；Command 负责提出目标或组合多个系统动作。

安装与使用

从 Releases 下载当前系统的安装包或 ZIP。

1. 启动软件并选择一个文件夹。
2. 空文件夹可以初始化新项目；已有 WPILib Java/C++/Gradle 项目会优先读取 project.yaml，否则保守分析源码与项目文件。
3. 在左侧项目树添加系统和设备，或从“预制模块”创建完整模块。
4. 检查底部 Diff 后应用修改。
5. 在设置中选择 IDE、PathPlanner 与 AdvantageScope 的自动检测或自定义路径。

完整操作说明见 中文使用指南。

本地开发

需要 Node.js 24 和 pnpm 10：

pnpm install
pnpm dev

常用命令：

pnpm check       # lint、格式、类型、测试和许可证检查
pnpm test:e2e    # 打包并执行 Electron E2E
pnpm test:acceptance-robot # 生成并编译完整示例机器人
pnpm make        # 为当前系统生成安装包

生成代码的职责边界和完整验收机器人说明见 Generated Project Architecture。

项目采用 pnpm workspace：桌面程序位于 apps/desktop，领域模型、解析、生成、预制与 NT 客户端位于 packages，FRC Base 模板和应用图标位于 resources。

自动发布

仓库管理员可打开 GitHub 的 Actions → Build and publish release → Run workflow，只需填写版本号， 例如 0.2.0。工作流会在 Windows、macOS、Linux 上验证并构建安装包，生成 SHA-256、SPDX SBOM 和依赖许可清单，随后创建 v0.2.0 Tag 与 GitHub Release。公开 Release 只提供 Windows EXE、macOS DMG、Linux DEB/RPM 安装包；便携包和审计文件保留在 Actions 构建产物中。

在首次运行发布工作流前，仓库的 /releases/latest 会返回 404；应用会将其显示为“尚无发布版本”，而不是更新检查失败。

详细签名和发布说明见 docs/RELEASE.md。

安全与代码所有权

生成代码可以在没有 FRC Framework 的环境中正常构建。手写 Java 推断出的逻辑树实体只用于浏览和跳转， 应继续在 IDE 中修改；软件会实时重新索引，但不会用结构化表单假装改写未知逻辑。Managed 区域冲突需要选择 保留代码、比较或重新生成。真实机器人部署、低功率测试和 NT 回写仍需由队伍按机械状态完成安全确认。

鸣谢

感谢 FRC Team 6941 IronPulse Robotics（ironpulse6941）分享其机器人代码架构和工程经验。 FRC Framework 的 lib.ironpulse 包组织与部分 API 概念参考了该团队的工作；Base 中的兼容实现为本项目独立编写，并未整包复制上游仓库。

状态与许可证

当前仍为预发布版本。已知限制见 docs/KNOWN_LIMITATIONS.md，恢复流程见 docs/RECOVERY.md。

Copyright © 2026 0.2Studio。本项目采用 MIT License，允许使用、复制、修改、合并、发布和分发，但须保留版权与许可声明。