How to make a Minecraft Compass (IRL): MCompass 烧录与编译指南

固件获取方式

如果你不打算修改源代码，可以直接下载编译好的二进制文件 (Firmware)。

1. 从 GitHub Actions 自动构建下载 (推荐)

本项目已配置 GitHub Actions 自动编译。通过这种方式，你可以始终获得对应最新代码的固件：

1. 前往 GitHub 项目的 Actions 页面。
2. 找到最近一次构建成功的 “Build Firmware Workflow” 记录。
3. 在页面下方的 Artifacts 区域，根据你的需求选择对应的 .bin 文件：

2. 手动编译

本项目使用 PlatformIO 进行管理：

• 固件: 基于 Arduino 框架，依赖库已完整迁移至本地 lib 文件夹。
• 网页资源 (Web Server): WiFi 模式后台使用 Next.js 开发。
  • 进入 Server 文件夹，执行 npm i 和 npm run build。
  • 将生成的 out 目录内容拷贝至固件的 data 文件夹下。
  • 使用 Firmware/assets/compass_web_data.py 进行资源压缩以减小 Flash 占用。

烧录指南

1. 使用官方工具 (PC)

下载 Flash Download Tool：

• 芯片选择: ESP32-C3
• 下载模式: USB
• 文件选择: 将下载的 .bin 文件加载到地址 0x0。
• 参数: SPI SPEED: 40MHz, SPI MODE: DIO。
• 注意: 固件已合并 bootloader 和 partition table，只需烧录至 0x0 即可。

2. 使用手机烧录 (Android)

如果你身边没有电脑，可以使用作者开发的 ESPFlash 直接通过手机 USB 指向烧录：

声明

• 版权声明: 本项目所用 Minecraft 像素素材版权归微软/Mojang 所有。本项目面板文件仅作为像素分布示意，不提供罗盘原始贴图。
• 商业用途禁止: PCB 背面使用的“标准银河字母”字体版权归原作者。如需进行任何商业行为，请务必删除背面丝印文字。