RollOfTheScoutClient — 童子军的命运之骰：客机显示

English ｜ 中文（见下方↓）

English

RollOfTheScoutClient is the client display addon for RollOfTheScout. It draws the host-broadcast class panel, effect notifications and overhead 【Class】Nickname prefix on your own screen.

Some highlights

• See your class on your own screen. Press the configurable key to open the class-assignment panel; effect notifications appear as toasts.
• Overhead class prefix. Players' name tags show 【Class】Nickname, drawn locally on each client (Disabled by default).
• Works alongside third-party name-tag mods (BetterPlayerDistance / Sense of Direction) through a compatibility layer.
• Reliable MilesSoul effects. Uses the same local gem detection and settlement as the main mod's client mode. Only this feature exchanges targeted handshake, configuration and usage-count messages; unmodded players are unaffected.
• Self-disabling. If the main mod is installed on the same machine, this addon turns itself off.
• By default, press Tab to view the relevant information in-game. Details for each class in main mod can be found in the mod class introduction document (ModClassIntroduction.md) included in the mod package.

Installation

Clients (this addon)

1. Install BepInEx for PEAK (BepInExPack_PEAK).
2. Put the file com.peakmodding.RollOfTheScoutClient.dll into PEAK/BepInEx/plugins/.

Host

The host must run RollOfTheScout. Class display requires class-display network sync; MilesSoul gameplay sync is independent of that display option and requires the new host version.

Configuration

• Config files are generated automatically on first run(BepInEx/config/com.peakmodding.RollOfTheScoutClient.cfg).
• Installing the ModConfig or ModConfigEnhance mod as well is recommended, so you can adjust the config live in-game. You can also edit the config file directly.

FAQ

• Do I need the main mod as well?
  • No. Install either the main mod (it provides both client-side features) or this lightweight addon — the addon disables itself if the main mod is present.
• Will this affect the host or other players?
  • Display remains local and receive-only. MilesSoul sends targeted handshake / usage-count messages to the host; the host uses them for spawn counts and does not repeat the local status effects.
• Nothing shows up — why?
  • The host must run the main mod and have class-display network sync enabled. Also, if you yourself are the host, there is no display broadcast to receive.

License & credits

• License: GPLv3.
• This mod was made with Deepseek V4.1 Flash.
• Special thanks to the PEAK community friends for their great support of this mod.

Found a bug or have a suggestion? General contact:

• Email: [email protected]
• Github: https://github.com/Rhys-214/RollOfTheScoutClient/issues

中文

RollOfTheScoutClient（童子军的命运之骰：客机显示） 是 RollOfTheScout 的轻量化客机显示附属模组。它在你自己屏幕上绘制职业分配面板、职业效果提示与头顶【职业】昵称前缀。

一些特色

• 在客机自己屏幕上看到职业 按下可配置的按键即可打开职业分配面板；职业效果提示会以 Toast 形式显示。
• 头顶职业前缀 玩家名牌上显示「【职业】昵称」，由各客户端本地绘制（默认禁用）。
• 兼容第三方头顶 id 显示模组（BetterPlayerDistance / Sense of Direction），通过兼容层让前缀也能出现在它们的标签上。
• 可靠的残魂效果 与主模组客机模式共用本机宝石检测与结算。仅该功能会定向交换握手、配置与使用计数消息；未安装它的玩家不受影响。
• 自我停用 若本机已安装主模组，本附属模组会自动停用。
• 默认按Tab键可在游戏内查看相关信息。模组各职业详情可查阅模组包中附带的模组职业介绍文档（ModClassIntroduction.md）。

安装

客机（本附属模组）

1. 为 PEAK 安装 BepInEx（BepInExPack_PEAK）。
2. 将文件 com.peakmodding.RollOfTheScoutClient.dll 放入 PEAK/BepInEx/plugins/。

主机

主机必须运行 RollOfTheScout。职业显示需开启「职业显示-网络同步」；残魂玩法同步不受该显示开关影响，但需要新版主机。

配置

• 配置文件将在首次运行自动生成（BepInEx/config/com.peakmodding.RollOfTheScoutClient.cfg）。
• 建议额外安装 ModConfig 或 ModConfigEnhance 模组，方便游戏内实时调整配置。你也可以直接编辑配置文件。

问答

• 还需要装主模组吗？
  • 不需要。装主模组（它本身也提供这两类客机功能）或装本轻量附属模组即可；若本机已有主模组，本附属模组会自动停用。
• 会影响主机或其他玩家吗？
  • 职业显示仍只在本机接收与绘制。残魂会向主机定向发送握手 / 使用计数消息，主机仅据此累计生成次数，不会重复施加本机已结算的状态效果。
• 什么都没显示，为什么？
  • 主机必须正在运行主模组并开启「职业显示-网络同步」；另外，如果你自己就是主机，则没有可接收的显示广播。

许可与致谢

• 许可证：GPLv3。
• 本模组使用 Deepseek V4.1 Flash 制作。
• 特别感谢PEAK同好群群友对本模组的大力支持。

有BUG或建议？通用联系方式：

• 邮箱：[email protected]
• Github：https://github.com/Rhys-214/RollOfTheScoutClient/issues