LZRTag 项目安装与配置指南

1. 项目基础介绍

LZRTag 是一个开源的激光标签游戏系统，它基于 ESP32 芯片，可以创建一个可定制的激光标签游戏。项目旨在提供一个易于修改的框架，让用户可以自行创建游戏模式和个人风格。整个项目包括硬件设计（电路板和外壳）和软件（固件和后端服务器）。

主要编程语言：

• C（主要硬件编程语言）
• Ruby（后端服务器编程语言）

2. 项目使用的关键技术和框架

关键技术：

• ESP32：一款功能强大、价格低廉的 Wi-Fi 和蓝牙芯片。
• MQTT：一种轻量级的消息传输协议，用于设备间的通信。
• I2S：数字音频接口，用于音频解码和放大。
• LSM6D：惯性测量单元，用于检测运动和碰撞。

框架：

• Ruby on Rails 或 Sinatra（可能用于后端服务器的Web框架，具体取决于项目配置）

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 确保你的计算机上安装了以下软件：

  • Git：用于克隆和更新项目代码。
  • Arduino IDE：用于编译和上传 ESP32 固件。
  • Ruby 和相关开发包：用于运行后端服务器。
  • MQTT 服务器：用于设备间的消息传递。

• 准备硬件：

  • ESP32 开发板。
  • IR 发射和接收模块。
  • WS2812 LED 灯。
  • 振动电机。
  • 按钮（触发、枪选择、装填）。
  • 3D 打印的外壳（可选）。

安装步骤

克隆项目

打开终端（或命令提示符），输入以下命令克隆项目代码：

git clone https://github.com/lzrtag/LZRTag.git
cd LZRTag

安装 Arduino IDE 和 ESP32 开发板支持

1. 下载并安装 Arduino IDE：https://www.arduino.cc/en/software
2. 打开 Arduino IDE，进入“文件”>“首选项”（Windows）或“Arduino”>“首选项”（Mac）。
3. 在“附加开发板管理器网址”中添加 ESP32 的 URL：https://dl.espressif.com/dl/package_esp32com_index.json
4. 打开“工具”>“开发板”>“开发板管理器”，搜索并安装 ESP32 开发板。
5. 选择你的 ESP32 开发板型号和端口。

编译和上传 ESP32 固件

1. 在项目目录中找到 ESP32 固件代码，通常是 src/ESP32 目录。
2. 使用 Arduino IDE 打开固件代码。
3. 点击“验证”按钮编译代码。
4. 通过 USB 连接 ESP32 开发板，并确保在 Arduino IDE 中选择了正确的端口。
5. 点击“上传”按钮将固件上传到 ESP32 开发板。

安装 Ruby 和相关依赖

1. 确保你的系统上安装了 Ruby。
2. 在项目目录中找到后端服务器的代码，通常是 src/backend 目录。
3. 使用以下命令安装项目依赖：

cd src/backend
bundle install

配置 MQTT 服务器

1. 下载并安装 MQTT 服务器，如 Mosquitto：https://mosquitto.org/
2. 确保服务器运行，并可以使用默认端口 1883。

运行后端服务器

1. 在终端中运行以下命令启动 Ruby 后端服务器：

ruby app.rb

2. 后端服务器应该会启动，并监听 MQTT 消息。

以上步骤是一个简化的安装和配置指南，具体细节可能会根据项目配置和更新有所不同，请参考项目的 README.md 文件以获取最新的信息和详细指导。