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

English ｜ 中文（见下方）

---

English

The client display addon for RollOfTheScout. It draws what the host broadcasts — the class-assignment panel, effect notifications (toasts) and the overhead 【Class】Nickname prefix — on each client's own screen. It never changes gameplay and never sends anything to the host.

Highlights

• Shows class info on the client's own screen: the class-assignment panel (key-triggered), effect notifications, and the overhead 【Class】Nickname prefix.
• Receive-only: the data comes from the host's broadcast (Photon custom event 197); this addon never raises events and never affects the rules.
• Needs the host to run the main mod (RollOfTheScout) with class-display network sync enabled — otherwise there is nothing to show.
• Self-disables when the main mod is already installed on the same machine (the main mod already provides the client-side display), so installing both is harmless.
• Bilingual configuration, selected automatically by the game language.
• Also adds a compatibility layer so the overhead prefix still shows up in third-party name-tag mods (BetterPlayerDistance / Sense of Direction).

Requirements

• PEAK (Steam)
• BepInEx for PEAK (BepInExPack_PEAK)
• On the host: the main mod RollOfTheScout

Installation (on clients)

1. Install BepInEx for PEAK.
2. Put the file com.peakmodding.RollOfTheScoutClient.dll into PEAK/BepInEx/plugins/.
3. Done — nothing else to set up.

Players who already run the main mod do not need this addon; it disables itself automatically.

Configuration

Config files are generated automatically on first run:

Game language	File
Chinese (Simplified / Traditional)	BepInEx/config/com.peakmodding.RollOfTheScoutClient.cfg
Any other language	BepInEx/config/com.peakmodding.RollOfTheScoutClient.en.cfg

Options: the class-display key, the display mode (HoldToShow / PressToShow / ToggleOnPress) and the overhead class prefix.

Building from source

Requirements: .NET SDK, PEAK, BepInEx 5.

# 1) Point the build at your local paths
#    copy Config.Build.user.props.example  ->  Config.Build.user.props
#    then fill in PeakRoot / BepInExCore

# 2) Build (Release)
dotnet build Mod/RollOfTheScoutClient/RollOfTheScoutClient.csproj -c Release

Output: Mod/RollOfTheScoutClient/bin/Release/com.peakmodding.RollOfTheScoutClient.dll.

Repository layout

.
├── Directory.Build.props            # repo-level MSBuild config (collects local paths)
├── Config.Build.user.props.example  # template for your local paths (copy to Config.Build.user.props)
├── README.md
├── LICENSE
└── Mod/
    ├── RollOfTheScoutClient/        # the client display addon
    └── Shared/                      # source shared with the main mod

Known constraints

• Class text is per-client local UI; a client without this addon (or the main mod) sees the class effects but no class text.
• If the host does not run the main mod, there is no broadcast and nothing is displayed.
• The addon draws only on the local screen; it cannot change what other players see.

License

Licensed under the GNU General Public License v3.0 (GPLv3), the same license as the main mod.

• ✅ You may use, modify and redistribute this mod — including commercially.
• ✅ Derivative works must be released under the GPLv3 too (share-alike: ship the source).
• ⚠️ Provided without any warranty.

Credits

• The RollOfTheScout main mod and the Silver mod (by fengsheng404) — the original design inspiration of main mod.
• BepInEx and HarmonyX.
• This mod was made with Deepseek V4.1 Flash.

Disclaimer

This is an unofficial third-party mod, not affiliated with PEAK's developers or publishers. This repository contains no game assemblies, decompiled game code, or other copyrighted assets.

A few words from the author

General contact: email [email protected].

---

中文

RollOfTheScout（童子军的命运之骰） 的客机显示附属模组。它把主机广播过来的数据 —— 职业分配面板、职业效果提示（Toast）、以及头顶的「【职业】昵称」前缀 —— 绘制在客机自己的屏幕上。它不改变任何玩法，也从不向主机发送任何东西。

特色

• 在客机自己屏幕上显示职业信息：职业分配面板（按键触发）、职业效果提示、以及头顶「【职业】昵称」前缀。
• 纯接收：数据来自主机的广播（Photon 自定义事件 197）；本模组从不发送事件，也绝不影响玩法规则。
• 需要主机安装主模组（RollOfTheScout）并开启「职业显示-网络同步」，否则没有可显示的数据。
• 自我停用：若本机已安装主模组，本模组会自动停用（主模组本身已提供客机显示），两者都装也不会冲突。
• 中英双语配置，按游戏语言自动切换。
• 另含兼容层，使头顶前缀在第三方头顶 id 显示模组（BetterPlayerDistance / Sense of Direction）中也能正常显示。

环境要求

• PEAK（Steam）
• PEAK 的 BepInEx（BepInExPack_PEAK）
• 主机端：需安装主模组 RollOfTheScout

安装（客机端）

1. 为 PEAK 安装 BepInEx；
2. 将文件 com.peakmodding.RollOfTheScoutClient.dll 放入 PEAK/BepInEx/plugins/；
3. 完成 —— 无需其它设置。

已经装了主模组的玩家不需要本附属模组；它会自动停用。

配置

配置文件将在首次运行自动生成：

游戏语言	文件
中文（简体 / 繁体）	BepInEx/config/com.peakmodding.RollOfTheScoutClient.cfg
其它任意语言	BepInEx/config/com.peakmodding.RollOfTheScoutClient.en.cfg

配置项：职业显示按键、显示模式（HoldToShow / PressToShow / ToggleOnPress）、头顶职业前缀。

从源码编译

前置：.NET SDK、PEAK、BepInEx 5。

# 1) 指向本机路径
#    复制 Config.Build.user.props.example → Config.Build.user.props
#    填写 PeakRoot / BepInExCore

# 2) 编译（Release）
dotnet build Mod/RollOfTheScoutClient/RollOfTheScoutClient.csproj -c Release

产物：Mod/RollOfTheScoutClient/bin/Release/com.peakmodding.RollOfTheScoutClient.dll。

仓库结构

.
├── Directory.Build.props            # 仓库级 MSBuild 配置（集中本机路径）
├── Config.Build.user.props.example  # 本机路径模板（复制为 Config.Build.user.props）
├── README.md
├── LICENSE
└── Mod/
    ├── RollOfTheScoutClient/        # 客机显示附属模组
    └── Shared/                      # 与主模组共用的源码

已知约束

• 职业文字属于各客户端本地 UI；未装本附属模组（也没装主模组）的客机只看得到职业效果，看不到职业文字。
• 若主机没有安装主模组，就没有广播来源，本模组不会显示任何内容。
• 本模组只绘制在本机屏幕上，无法改变其他玩家看到的内容。

许可证

本项目采用 GNU 通用公共许可证第 3 版（GPLv3），与主模组一致。

• ✅ 可以自由使用、修改与再分发（包括商业用途）；
• ✅ 衍生作品必须以 GPLv3 发布（相同方式共享：需一并提供源码）；
• ⚠️ 本程序不提供任何担保。

致谢

• RollOfTheScout 主模组，以及 Silver 模组（作者 fengsheng404）—— 主模组最初的设计灵感来源。
• BepInEx 与 HarmonyX。
• 本模组使用 Deepseek V4.1 Flash 制作。

免责声明

本模组为第三方非官方作品，与 PEAK 的开发 / 发行方无任何关联。本仓库不包含任何游戏程序集、游戏反编译源码或其它受版权保护的资源。

一些作者的话

• 作者通用联系方式：邮箱 [email protected]（当然，你也可以直接加QQ反馈意见与建议）
• 欢迎加入PEAK同好群喵（QQ群：814891614，模组更新将优先在本群内测）~