{"url":"https://levimc.org/mods/github.com/MRUIAW/BedrockBoatHUD/","id":"github.com/MRUIAW/BedrockBoatHUD","name":"BoatHUD","description":"A racing HUD and driving assistant for boats on LeviLamina clients.","owner":"MRUIAW","logo":"https://raw.githubusercontent.com/MRUIAW/BedrockBoatHUD/refs/heads/main/pack_icon.png","repository":"https://github.com/MRUIAW/BedrockBoatHUD","issues":"https://github.com/MRUIAW/BedrockBoatHUD/issues","releases":"https://github.com/MRUIAW/BedrockBoatHUD/releases","stars":1,"downloads":97,"updated":"2026-10-04T18:14:39Z","published":"2026-09-30T17:20:57Z","created":"2026-09-26T18:54:36Z","license":"LGPL-3.0","side":["client"],"platform":["win-x64"],"gameVersions":["1.26.51"],"tags":["platform:levilamina","type:mod","hud"],"latest":{"variant":"client","version":"1.0.1","install":"lip install github.com/MRUIAW/BedrockBoatHUD#client@1.0.1"},"readmes":[{"file":"README.md","lang":"en","text":"# Bedrock BoatHUD\n\n[![简体中文](https://img.shields.io/badge/README-简体中文-blue)](README.zh-CN.md)\n[![Release](https://img.shields.io/github/v/release/MRUIAW/BedrockBoatHUD)](https://github.com/MRUIAW/BedrockBoatHUD/releases)\n\nA client-side boat racing HUD for Minecraft Bedrock Edition, built with [LeviLamina](https://lamina.levimc.org/). Inspired by [Hibiii/BoatHud](https://github.com/Hibiii/BoatHud) and [BoatHUD Extended](https://github.com/jewtvet/boathud_extended).\n\n⚠️Warning⚠️: **Every line of code is generated by AI**. If you have concerns about AI-generated code, please don't use it. **This is a project experimenting with whether AI can vibe out simple mods + find + hook memory addresses on its own.** There's a readme about the AI development process in the repo root. If you're not good at C++ but want to make some simple mods, feel free to give it a read.\n\n## Features\n\n- Boat and chest-boat driver detection, with **Race** as the default layout and **Classic** / **Compact** alternatives.\n- Speed, slip angle, longitudinal/lateral acceleration, server ping, and HUD render FPS.\n- BoatHUD-style pixel speed bars, an acceleration indicator, steering/throttle traces, and optional left/right arrows and forward/reverse icons.\n- An in-game settings screen with the native mouse cursor, immediate changes, and English / Simplified Chinese localization following the game language.\n- Optional Hibiii-style camera assistance, smoothly blending the boat heading toward its travel direction as speed increases.\n- Optional vanilla HUD hiding, CSV telemetry, and checkpoint time/speed comparisons.\n\nCamera assistance, vanilla HUD hiding, telemetry, and checkpoints are **off by default**. Speed smoothing is on. The mod has no resource-pack requirement.\n\n## Installation\n\nVersion 1.0.1 targets **Minecraft Bedrock 1.26.51.01**, **LeviLamina 26.51.x** (tested with 26.51.5), and **Windows x64 clients only**. Other game/loader series and dedicated servers are not supported.\n\n### Through LeviLauncher (recommended)\n\nDownload [LeviLauncher](https://github.com/LiteLDev/LeviLauncher), open its `Bedrinth` browser, and search for “BoatHud”. Choose a version compatible with your game. A new release may take time to appear in the index; use lip or manual installation below if it is not listed yet.\n\n### Through lip\n\nClose Minecraft before installing or updating. With [lip](https://lip.levimc.org/), run this in the LeviLamina game instance directory:\n\n```powershell\nlip install \"github.com/MRUIAW/BedrockBoatHUD#client\"\n```\n\n### Manual installation\n\nAlternatively, download `BedrockBoatHUD-client-windows-x64.zip` from [Releases](https://github.com/MRUIAW/BedrockBoatHUD/releases), then copy its `BoatHUD` directory into your instance's `mods` directory. Keep existing `config` and `data` directories when updating. Release titles follow `v<mod-version>-mc<game-series>` (currently `v1.0.1-mc26.5x`); this label does not broaden the compatibility listed above. Only one freshly built client archive is published.\n\nThe installation directory is `mods/BoatHUD/`. With Minecraft closed, move any earlier `mods/BedrockBoatHUD` installation outside `mods` before loading the new mod; old settings are not migrated automatically.\n\nStart the game and take the driver's seat in a boat. BoatHUD appears while you are driving; passengers do not receive a driving HUD.\n\n## Controls\n\n| Key | Action |\n| --- | --- |\n| `B` | Toggle BoatHUD |\n| `N` | Cycle Race → Classic → Compact |\n| `C` | Toggle camera assistance |\n| `O` | Open settings |\n\nIn settings, hover a row and left-click for the next value or right-click for the previous value. Up/down arrows select rows; left/right arrows, Enter, and Space change values. `O`, `Esc`, or Done closes the screen. Changes are saved automatically. Vanilla HUD hiding is a menu option without a separate hotkey.\n\nMovement indicators read the game's movement state, supporting remapped movement keys and controller input. The four mod hotkeys above are fixed.\n\n## Speed bars\n\nThe bar scale always uses **m/s**, regardless of the displayed speed unit.\n\n| Profile | Range | Colour sections |\n| --- | --- | --- |\n| Water & Packed Ice (`packed`, default) | 0–40 m/s | Blue below 8 m/s, grey/white above it |\n| Mixed Ices (`mixed`) | 0–72 m/s | Grey/white below 40 m/s, blue above it |\n| Blue Ice (`blue`) | 40–72.7 m/s | Blue throughout |\n\nThe lit section follows speed and flashes above the profile's maximum. Speed bars stay inside the panel border. Race acceleration values use two decimal places below an absolute value of 10 and one decimal place at or above 10, independently for each displayed value.\n\n## Configuration and language files\n\nPaths are relative to the game instance:\n\n| Path | Purpose |\n| --- | --- |\n| `mods/BoatHUD/config/config.json` | Settings; created on first load |\n| `mods/BoatHUD/lang/en.json` | English UI text |\n| `mods/BoatHUD/lang/zh_CN.json` | Simplified Chinese UI text (`zh-Hans` / Minecraft `zh_CN`) |\n| `mods/BoatHUD/data/telemetry/` | Timestamped telemetry CSV files |\n| `mods/BoatHUD/config/checkpoints.csv` | Default checkpoint file |\n\nEdit JSON with Minecraft closed, or use the settings menu. Available speed units are `ms`, `kmh`, `mph`, and `knots`; acceleration units are `g` and `mss`. Advanced camera settings are `cameraAggressiveness` (default 60 m/s), `cameraSmoothing` (0.45 retained per tick), and `cameraMinimumSpeed` (0.5 m/s). Configuration schema version 3 is independent of the mod's release version.\n\n## Telemetry and checkpoints\n\nEnable Telemetry CSV in settings while driving to begin recording. Disabling it or ending the driving session flushes and closes the file. Exported values use explicit units and are independent of HUD units. The CSV includes a format-version comment before its header; it is **not identical to the Java mod's 11-column export**. Skip the first comment line when importing into a spreadsheet.\n\nCheckpoint files use five columns:\n\n```csv\nreference_time_seconds,reference_speed_mps,normal_x,normal_z,plane_offset\n0.000,0.000,0.000,1.000,100.000\n5.000,40.000,0.000,1.000,200.000\n```\n\nA checkpoint plane is `x * normal_x + z * normal_z = plane_offset`; it triggers only when crossed from its negative side to its positive side. The first checkpoint establishes the lap start. Enable `circularTrack` in JSON to repeat the sequence. Checkpoints must be prepared manually; the feature is implemented but has not received the same real-track acceptance coverage as the HUD and camera.\n\nSee [the telemetry guide (Chinese)](TELEMETRY_GUIDE.md) and [checkpoint example](examples/checkpoints.csv). HUD FPS measures this overlay's rendering, rather than an independent whole-game benchmark. Player-name display is reserved in configuration and is not rendered in 1.0.1.\n\n## Building and maintenance\n\nRequires Windows x64, XMake, LLVM/Clang 22, and Visual Studio C++ Build Tools with a Windows SDK.\n\n```powershell\nxmake f -a x64 -m release -p windows --target_type=client -y\nxmake -y\npwsh -File scripts/Package-Release.ps1\n```\n\nThe mod directory is generated in `bin/BoatHUD/`, and the validated ZIP in `build/release/`. [CHANGELOG.md](CHANGELOG.md) records releases. [AGENTS.md](AGENTS.md) is the maintenance handoff, covering coding rules, version upgrades, camera symbols, screen/mouse behaviour, and publishing. [DEVELOPMENT_STATUS.md](DEVELOPMENT_STATUS.md) preserves development and acceptance history; earlier sections may describe superseded implementations.\n\n## Credits and license\n\nProject code is released under [CC0-1.0](LICENSE). BoatHUD designs and camera behaviour are credited to the two Java projects above. HUD graphics are drawn with Bedrock UI primitives; the original binary textures are not bundled. This project is not affiliated with Mojang, Microsoft, or the original mod authors.\n"},{"file":"README.zh-CN.md","lang":"zh-Hans","text":"# Bedrock BoatHUD\n\n[![English](https://img.shields.io/badge/README-English-blue)](README.md)\n[![Release](https://img.shields.io/github/v/release/MRUIAW/BedrockBoatHUD)](https://github.com/MRUIAW/BedrockBoatHUD/releases)\n\n基于 [LeviLamina](https://lamina.levimc.org/zh/) 的 Minecraft 基岩版客户端赛船 HUD，参考了 [Hibiii/BoatHud](https://github.com/Hibiii/BoatHud) 和 [BoatHUD Extended](https://github.com/jewtvet/boathud_extended) 的设计与驾驶体验。\n\n⚠️警告⚠️：**该项目的每一行代码都是由AI进行生成的。**如果你对AI生成的代码有顾虑，请勿使用。**这是一个实验AI能否vibe出简单模组+自己寻找+hook内存地址的项目**，repo的根目录下有关于AI开发过程的readme，若你不擅长C++却想做一些简单的mod的话，欢迎阅读。\n\n## 功能\n\n- 自动识别普通船、运输船的驾驶者；默认使用 **Race（竞速）** 布局，也可切换 **Classic（经典）**、**Compact（紧凑）**。\n- 显示速度、侧滑角、纵向/横向加速度、服务器延迟和 HUD 渲染 FPS。\n- BoatHUD 风格的像素速度条、加速度指示器、转向/油门轨迹，以及可选的左右箭头和前进/后退图标。\n- 游戏内设置界面使用原生鼠标光标；设置即时生效，自动跟随游戏语言显示英文或简体中文。\n- 可选 Hibiii 式镜头辅助：速度越高，视角越偏向实际运动方向，并进行平滑处理。\n- 可选原版 HUD 隐藏、遥测 CSV、检查点时间差和速度差。\n\n镜头辅助、隐藏原版 HUD、遥测和检查点均**默认关闭**；速度平滑默认开启。无需安装额外资源包。\n\n## 安装\n\n1.0.1 适用于 **Minecraft 基岩版 1.26.51.01**、**LeviLamina 26.51.x**（已测试 26.51.5），且**仅支持 Windows x64 客户端**。不支持其他游戏/加载器系列或专用服务端。\n\n### 通过 LeviLauncher 安装（推荐）\n\n下载 [LeviLauncher](https://github.com/LiteLDev/LeviLauncher)，启动 LeviLauncher 并打开 `Bedrinth`，在其中搜索“BoatHud”，然后选择与您的游戏版本兼容的版本。新发布的版本可能需要等待索引更新；暂未搜到时可使用下方 lip 或手动安装方法。\n\n### 通过 lip 安装\n\n安装或更新前完全退出 Minecraft。在 LeviLamina 游戏实例目录中使用 [lip](https://lip.levimc.org/)：\n\n```powershell\nlip install \"github.com/MRUIAW/BedrockBoatHUD#client\"\n```\n\n### 手动安装\n\n从 [Releases](https://github.com/MRUIAW/BedrockBoatHUD/releases) 下载 `BedrockBoatHUD-client-windows-x64.zip`，将压缩包中的 `BoatHUD` 文件夹放进实例的 `mods` 文件夹。更新时保留原有 `config` 和 `data` 文件夹。Release 标题统一为 `v<模组版本>-mc<游戏系列>`，当前为 `v1.0.1-mc26.5x`；标题不扩大上述实际兼容范围。仅发布一份重新编译的客户端包。\n\n实际安装目录为 `mods/BoatHUD/`。安装前退出游戏，将早期版本的 `mods/BedrockBoatHUD` 移到 `mods` 目录之外，避免两个模组同时加载；旧配置不自动迁移。\n\n启动游戏并坐上船的驾驶位即可看到 HUD；作为乘客时不显示驾驶 HUD。\n\n## 操作\n\n| 按键 | 功能 |\n| --- | --- |\n| `B` | 开启/关闭 BoatHUD |\n| `N` | 按 Race → Classic → Compact 切换布局 |\n| `C` | 开启/关闭镜头辅助 |\n| `O` | 打开设置 |\n\n设置中将鼠标移到一行上，左键切换到下一值，右键切换到上一值。方向键上下选择行，左右调整；回车和空格也可切换。按 `O`、`Esc` 或选择“完成”关闭，修改自动保存。“隐藏原版 HUD”仅在菜单内设置，没有独立快捷键。\n\n移动图标读取游戏的移动输入，支持移动键重新绑定和手柄；上述四个模组快捷键为固定键位。\n\n## 速度条\n\n速度条量程始终按 **m/s** 计算，与速度数字选择的单位无关。\n\n| 模式 | 量程 | 颜色分区 |\n| --- | --- | --- |\n| 水与浮冰（`packed`，默认） | 0–40 m/s | 8 m/s 以下为蓝色，其后为灰白色 |\n| 混合冰（`mixed`） | 0–72 m/s | 40 m/s 以下为灰白色，其后为蓝色 |\n| 蓝冰（`blue`） | 40–72.7 m/s | 全蓝色 |\n\n点亮长度随速度变化，超过上限时闪烁，速度条保持在面板边框内部。Race 的两个加速度读数分别按绝对值选取小数位：小于 10 显示两位小数，大于等于 10 显示一位小数。\n\n## 配置与语言文件\n\n以下路径均相对于游戏实例目录：\n\n| 路径 | 用途 |\n| --- | --- |\n| `mods/BoatHUD/config/config.json` | 配置；首次加载时生成 |\n| `mods/BoatHUD/lang/en.json` | 英文界面文本 |\n| `mods/BoatHUD/lang/zh_CN.json` | 简体中文文本（`zh-Hans` / Minecraft `zh_CN`） |\n| `mods/BoatHUD/data/telemetry/` | 带时间戳的遥测 CSV |\n| `mods/BoatHUD/config/checkpoints.csv` | 默认检查点文件 |\n\n手工修改 JSON 前退出游戏，也可以直接使用设置菜单。速度单位支持 `ms`、`kmh`、`mph`、`knots`，加速度单位支持 `g`、`mss`。高级镜头参数为 `cameraAggressiveness`（默认 60 m/s）、`cameraSmoothing`（每 Tick 保留比例 0.45）、`cameraMinimumSpeed`（0.5 m/s）。配置格式版本 3 与模组发布版本相互独立。\n\n## 遥测与检查点\n\n驾驶时在设置中开启“遥测 CSV”立即开始记录；关闭该选项或结束驾驶会刷新并关闭文件。导出使用固定单位，不随 HUD 单位改变。CSV 第一行是格式版本注释，第二行是表头，**并非 Java 原作的 11 列原样导出格式**。导入表格软件时跳过第一行。\n\n检查点文件使用五列：\n\n```csv\nreference_time_seconds,reference_speed_mps,normal_x,normal_z,plane_offset\n0.000,0.000,0.000,1.000,100.000\n5.000,40.000,0.000,1.000,200.000\n```\n\n检查点平面为 `x * normal_x + z * normal_z = plane_offset`，从负侧穿越到正侧才触发。第一点建立圈起点；在 JSON 中开启 `circularTrack` 可循环检查点序列。检查点需手工准备；功能已实现，但真实赛道验收覆盖还没有 HUD 和相机充分。\n\n详见 [遥测使用指南](TELEMETRY_GUIDE.md) 和 [检查点示例](examples/checkpoints.csv)。FPS 表示此 HUD 的渲染帧率，不是独立的整游戏性能测试；配置中的玩家名称显示字段为预留项，1.0.1 不绘制玩家名称。\n\n## 构建与维护\n\n需要 Windows x64、XMake、LLVM/Clang 22、Visual Studio C++ Build Tools 和 Windows SDK。\n\n```powershell\nxmake f -a x64 -m release -p windows --target_type=client -y\nxmake -y\npwsh -File scripts/Package-Release.ps1\n```\n\n模组目录输出到 `bin/BoatHUD/`，校验后的 ZIP 输出到 `build/release/`。[CHANGELOG.md](CHANGELOG.md) 记录发布变更；[AGENTS.md](AGENTS.md) 为后续维护者提供规范、版本升级、相机符号、菜单鼠标及发布流程说明。[DEVELOPMENT_STATUS.md](DEVELOPMENT_STATUS.md) 保留开发与验收历史，其中早期方案可能已被后续版本替代。\n\n## 致谢与许可证\n\n项目代码使用 [CC0-1.0](LICENSE)。BoatHUD 设计与镜头行为参考上述两个 Java 项目。HUD 通过基岩版原生 UI 图元绘制，发行包没有包含原作的二进制纹理。本项目与 Mojang、Microsoft 及原模组作者没有隶属关系。\n"}],"gallery":[],"versions":[{"version":"1.0.1","prerelease":false,"released":"2026-10-04T18:14:39Z","releaseUrl":"https://github.com/MRUIAW/BedrockBoatHUD/releases/tag/v1.0.1","manifestUrl":"https://github.com/MRUIAW/BedrockBoatHUD/blob/v1.0.1/tooth.json","info":{"name":"BoatHUD","description":"A racing HUD and driving assistant for boats on LeviLamina clients.","tags":["platform:levilamina","type:mod","hud"],"logo":"https://raw.githubusercontent.com/MRUIAW/BedrockBoatHUD/refs/heads/main/pack_icon.png"},"variants":{"client":[{"side":"client","platform":"win-x64","deps":{"github.com/LiteLDev/LeviLamina#client":"26.51.*"}}]}},{"version":"1.0.0","prerelease":false,"released":"2026-09-30T17:20:57Z","releaseUrl":"https://github.com/MRUIAW/BedrockBoatHUD/releases/tag/v1.0.0","manifestUrl":"https://github.com/MRUIAW/BedrockBoatHUD/blob/v1.0.0/tooth.json","info":{"name":"Bedrock BoatHUD","description":"A racing HUD and driving assistant for boats on LeviLamina clients.","tags":["platform:levilamina","type:mod"]},"variants":{"client":[{"side":"client","platform":"win-x64","deps":{"github.com/LiteLDev/LeviLamina#client":"26.51.*"}}]}}],"dependencies":{"github.com/liteldev/levilamina":{"id":"github.com/LiteLDev/LeviLamina","name":"LeviLamina","owner":"LiteLDev","url":"https://levimc.org/mods/github.com/LiteLDev/LeviLamina/"}},"requiredBy":[]}