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:

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. 完成 —— 无需其它设置。

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

配置

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

配置项：职业显示按键、显示模式（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，模组更新将优先在本群内测）~

Changelog · 更新日志

1.0.8

English

• Fixed Chaos Enderman (code 31) local intro fallback showed the full detailed effects instead of the short summary; it now matches the main mod's class document.
• Changed Bundled ModClassIntroduction.md refreshed for main mod v1.1.2 (Alchemist +10 / every 12 with the same-item tally rule, Trickster sugar 123 s, transfer wording).
• Note Display-only; no config keys changed. Main mod v1.1.2 is recommended for matching text.
• New Companion Pandora Battle Royale survival display support (Kind 11 / 12): survival status panel and automatic return to the class panel.

中文

• 修复 混乱末影人（职业码 31）本地兜底简介显示为详细效果而非短简介；现与主模组的职业文档一致。
• 调整 随包 ModClassIntroduction.md 同步主模组 v1.1.2（炼金术士 +10 / 每 12 次与连续同类不计数、捣蛋鬼发糖 123 秒、转移说明）。
• 注意 仅为显示，未改动任何配置键；建议搭配主模组 v1.1.2。
• 新增 支持配套 潘多拉大乱斗 的存活状态显示（Kind 11 / 12）：存活状态面板，以及模式结束后自动恢复职业面板。

1.0.7 - 🎃Halloween Update·万圣节更新！

English

• New Added local fallback name / keywords / intro for the Chaos Enderman (code 31), Gargoyle (code 32), Alchemist (code 33) and Trickster (code 34) classes added by main mod v1.1.0; display-only, no gameplay code.
• Note The host already broadcasts new class names and introductions, so older addon versions can display them too; this build only removes the brief "no class" placeholder before the broadcast arrives.
• Fixed MilesSoul 【Rule Zero】 local settlement: the 3-second petrify correction window now always ends and cleans up (fallback extra stamina + warning if needed), and a missing pre-use petrify snapshot is logged and skipped instead of silently using the post-cost value.

中文

• 新增 为主模组 v1.1.0 更新新增的职业混乱末影人（职业码 31）、石像鬼（职业码 32）、炼金术士（职业码 33）、捣蛋鬼（职业码 34）补充本地兜底名称 / 关键词 / 简介；仅为显示，不含玩法代码。
• 注意 主机本就会广播新职业名称与介绍，更旧的附属模组版本也能显示；本版本只是消除广播到达前短暂的「无职业」占位。
• 修复 残魂【零号守则】本机结算：3 秒石化校正窗口到期必定收尾（必要时兜底发放一次额外体力并写警告）；缺失「使用前」石化快照时改为写警告并跳过抵消，不再静默以代价后的值当基准。

1.0.6

English

• New MilesSoul gameplay support: with main-mod host v1.0.9+, this addon uses the same local Scout gem detection and settlement as the main mod's client mode, with host-synced config. This avoids stale host petrify writebacks during rapid use.
• Fixed MilesSoul 【Rule Zero】 now grants +30 extra stamina only after the feeding-related petrify has been cleared.
• Changed Only MilesSoul now exchanges targeted handshake / usage-count messages with the host; class display remains receive-only. The addon still self-disables when the main mod is installed.
• Optimised MilesSoul handshake: unchanged state is not re-parsed, ACK is 8 s, scene check is cached, hello is gameplay-only, and host replies are hello-driven.
• Fixed The top-left notice box could be one line tall for a two-line bilingual notice in the IMGUI fallback (each line half cut); heights are now measured per entry with wrapping.

中文

• 新增 残魂玩法支持：主机为 v1.0.9+ 时，本附属模组与主模组客机模式共用本机宝石检测与结算，并同步主机配置，避免高频使用时旧石化值写回。
• 修复 残魂【零号守则】改为先清除本次喂食产生的石化，再发放 +30 额外体力。
• 调整 仅残魂功能会与主机定向交换握手 / 使用计数消息；职业显示仍为纯接收。本机安装主模组时仍会自我停用。
• 优化 残魂握手开销：未变状态不再解析、ACK 改为 8 秒、场景判定缓存、Hello 仅关卡内发送；主机回复改为由 Hello 触发。
• 修复 IMGUI 回退路径下，左上角提示窗口对含换行的双语提示只按单行高度绘制，导致每行各露一半；现按每条实际排版高度计算并启用折行。

1.0.5

English

• Fixed The class intro could show another class's description (usually after a reclass, with the correct class name in the title): the intro table's M / Savage entries were swapped (M = 8, Savage = 9).
• Changed The class intro panel now sits in the top-left corner (not under the class list); while it is visible, top-left notifications move below it and return afterwards.

中文

• 修复 职业简介显示成其他职业的简介：简介表 M / 野人两项写反（M = 8、Savage = 9）。
• 调整 职业介绍板块移至屏幕左上角（不再挂在职业分配面板下方）；该板块显示期间，左上角提示临时下移到其下方，关闭后自动复位。

1.0.4

English

• Changed Bilingual display and config: Name：EnglishClass · 中文职业 rows, English-then-Chinese intro lines, bilingual config names (ClassDisplay-Key职业显示-按键) with automatic backup/regeneration of old config files.
• Changed The overhead class prefix is now off by default (overheadClassPrefix = false) because it runs per frame and can clash with other name mods.
• New Supports targeted notices (event 197 kind 6); only the targeted client displays them.
• Changed Overlay text is no longer bold, and a thinner font is preferred when available.

中文

• 调整 显示与配置改为中英双语：面板显示 玩家名：EnglishClass · 中文职业，介绍先英文后中文；配置文件固定中英双语（ClassDisplay-Key职业显示-按键）；旧配置自动备份并重建。
• 调整 头顶职业前缀默认改为关闭（overheadClassPrefix = false）：该功能每帧运行，且易与其它名称模组冲突掉帧。
• 新增 支持定向提示（事件 197 Kind 6），仅目标客机显示。
• 调整 屏幕文字取消加粗，并在可用时优先使用更细的字体。

1.0.2

English

• Add a class introduction document for this mod (ModClassIntroduction.md, bilingual in Chinese and English).
• New The class-assignment panel now also shows your own class's keywords and a short introduction right below it (Chinese / English follows the game language), so you can understand your class without opening the class document.
• Improved Classes added by a future main-mod update are still described: the host broadcasts their keywords + intro, so this addon does not need a matching update.
• Optimised Cached class-panel text and overhead-prefix state, so holding the panel key no longer rebuilds text every frame.

中文

• 为本模组补充职业介绍文档（ModClassIntroduction.md，中英双语）。
• 新增 职业分配面板下方会同时显示本人职业的关键词与简介（中英文本随游戏语言），无需翻阅职业文档即可快速了解自己的职业。
• 改进 主模组日后新增职业时，本附属模组无需同步更新也能显示其介绍（主机广播关键词+简介）。
• 优化 职业面板文本与头顶前缀状态改为缓存，按住面板键时不再每帧重建文本。

1.0.1

English

• Urgently fixed some issues with the mod configuration file.

中文

• 紧急修复了模组配置文件的一些问题。

1.0.0

English

• Initial public release of the client display addon for RollOfTheScout.
• GUID com.peakmodding.RollOfTheScoutClient; requires the host to run the main mod RollOfTheScout with class-display network sync enabled.
• Shows the class-assignment panel, effect notifications (toasts) and the overhead class prefix on the client's own screen, using the host's broadcast (Photon custom event 197).
• Receive-only: never sends events and never changes gameplay.
• Self-disables when the main mod is installed on the same machine.
• Includes a compatibility layer for third-party name-tag mods (BetterPlayerDistance / Sense of Direction).
• Bilingual config (Chinese / English), selected automatically by the game language.

中文

• RollOfTheScout 的客机显示附属模组首个公开发布版本。
• GUID com.peakmodding.RollOfTheScoutClient；需主机运行主模组 RollOfTheScout 并开启「职业显示-网络同步」。
• 借助主机的广播（Photon 自定义事件 197），在客机自己屏幕上显示职业分配面板、职业效果提示（Toast）与头顶职业前缀。
• 纯接收：从不发送事件、绝不改变玩法。
• 本机已装主模组时自动停用。
• 含第三方头顶 id 显示模组（BetterPlayerDistance / Sense of Direction）兼容层。
• 配置中英双语，按游戏语言自动切换。