sganggs/Stronghold-Protocol

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/sganggs/Stronghold-Protocol.svg?style=card)](https://bestofgithub.dev/repo/sganggs/Stronghold-Protocol)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/sganggs/Stronghold-Protocol.svg)](https://bestofgithub.dev/repo/sganggs/Stronghold-Protocol)

Loading README…

同盟房间	策略轮选	休整期（商店 / 盟约）

部署方向轮盘	作战	最终攻势

项目	要求
开服的电脑	Windows / macOS / Linux，Node.js 22 或 24（LTS）；磁盘约 1.2–1.4 GB（素材、依赖与本地提取的贴图、场景和特效：完整包解压后约 1.16 GB）；内存空闲约 100 MB，每局再加几 MB
玩家	支持 WebGL 的现代浏览器（Chrome / Edge / Firefox / Safari 最新版），电脑、手机或平板（横屏）
网络	首次进入游戏时，每位玩家要从开服的电脑下载几十 MB 素材（之后走浏览器缓存）；对局中流量很小。已有素材的玩家可以在标题画面点「导入素材包」（「下载完整素材」旁边），从素材包 zip、完整包 zip 或自己的 `public/assets` 文件夹导入，这部分美术不再从开服的电脑下载；需要 HTTPS 或 localhost（docs/DEPLOY.md 2.5 节）。0.3.0 的素材包 `Stronghold-Protocol-v0.3.0-assets.zip` 由维护者另行提供下载，不在 Releases 附件里

环境变量	默认	说明
`PORT`	`3000`	监听端口
`HOST`	`::`	监听地址。默认 `::` 是双栈：同一个端口同时接受 IPv6 和 IPv4；`0.0.0.0` = 只 IPv4；`127.0.0.1` = 只允许本机，放在反向代理后面时使用
`SP_COMBAT`	`client`	`client`：各玩家浏览器模拟自己的战斗（服务器负载极低）；`server`：由服务器模拟并推流
`SP_VERIFY`	`off`	服务器复算客户端上报的战斗结果：`off` / `sample`（约 1/8 抽查）/ `all`（全部复算，更耗 CPU）
`SP_BOT_REHEARSAL`	不设（服务器试算）	仅 `host` 让房主浏览器帮 AI 队友试算布阵（同源 Worker，只回候选序号）；不设或 `server` 仍由服务器试算。房主无法完成时服务器用同一批候选接手。玩法插件房间始终由服务器试算。真人「AI 托管」和正式战斗不受影响
`TRUST_PROXY`	`auto`	是否信任 `X-Forwarded-For` 等转发头：`auto` 只信任来自本机 / 内网的代理；`1` 总是；`0` 从不
`DEBUG`	空	设为任意值输出详细日志
`SP_NO_BROWSER`	空	设为 `1` 时启动脚本不自动打开浏览器
`SP_BOT_EMOTES`	空	AI 队友的对局表情回应（战斗、整备、合成、联防、收礼时即刻的 `m.emote` 广播）；设为 `0` 时整体关闭
`SP_ASSET_INDEX`	空	素材地址带内容哈希、浏览器长期缓存（0.2.6 起默认开启，哈希存在 `.cache/asset-hashes.json`）；设为 `0` 时关闭，素材清单原样下发
`SP_VERSIONS`	不设（四个官方版本都开，默认第二期下半）	收窄启用的版本：不设置与 `all` 相同；`act2autochess` 只开第二期下半，大厅不显示「版本」；也可写逗号分隔的版本 id（如 `act1autochess,act2autochess@V2_1`）。`SP_VERSION_DEFAULT` 指定默认版本，`SP_MAX_VERSION_HOSTS` 限制版本模拟进程数（空闲时不额外启动进程）。详见 DEPLOY.md §11
`SP_BOT_STRATEGY` / `SP_EXTERNAL_AI_` / `SP_LLM_`	不设（内置 AI）	外部 AI 与顾问模式目前只在开发分支上。发布包和 Docker 镜像会忽略这些变量，仍用内置 AI，并打一行日志。详见 DEPLOY.md

方式	怎么做	适合
同一局域网直连	把启动窗口里的局域网地址发给朋友	同一个家、宿舍或网吧
组网工具（虚拟局域网）	例如 Tailscale、ZeroTier、EasyTier、蒲公英：开服的人和朋友都安装同一个工具并加入同一个网络，朋友用开服电脑的虚拟 IP 访问 `http://<虚拟 IP>:3000`	固定的几个熟人；不暴露到公网。朋友也要装客户端，部分工具需要注册账号；跨地区时可能走中继而变慢
内网穿透 / 隧道	只有开服的人运行客户端，朋友直接打开网址。例如自建的 frp（需要一台有公网 IP 的服务器）、Cloudflare 的 `cloudflared tunnel --url http://localhost:3000`（临时地址，每次启动都会变；国内访问延迟可能较高）、国内的樱花 frp 一类公共穿透服务（通常需要实名，大陆节点承载网页可能有备案要求）	不想改路由器、没有公网 IP；免费线路带宽小时，首次加载素材会慢一些
云服务器 / VPS 直接部署	在 VPS 上运行整合包，或用仓库自带的 `Dockerfile`；用 Caddy / Nginx 加上 HTTPS。选离玩家近、线路好的地区（面向大陆玩家时，境外机房要关注回程线路，否则晚高峰延迟可能很高；大陆服务器绑定域名需要 ICP 备案）	想长期开服、玩家分布在不同地区

操作	方法
购买 / 升级调度中心 / 机变选卡	点一次选中，再点一次确认（`D` 升级）
部署 / 移动干员	从整备区拖到棋盘格 → 出现方向轮盘 → 往上 / 右 / 下 / 左滑动选择朝向后松手；松在中心或点「✕ 点击取消」取消。拖动时指针 / 手指所在的格子就是落点，能放下时模型直接站在这一格上（不能放下时跟在指针下）
调整朝向	把干员拖回它自己的格子，再选方向
出售 / 撤退 / 销毁装备	点击单位所在的格子 → 底部按钮「出售 +1」「撤退」；也可以把棋盘上的干员拖回整备区撤退。整备区里的装备与法术只能「销毁」，已配发的装备锁定在干员身上（干员出售或合成精锐时退回整备区）
装备	把装备拖到干员所在的格子上（每人 2 件；满了会弹出替换窗口，被替换的一件会被销毁）；法术拖到地块上并选方向
查看详情	右键或长按单位 / 卡牌（属性为实时数值，高于基础值为绿色、低于为红色）
快捷键	`W` 购买鼠标指向的商品（无需点击） · `R` 刷新 · `F` 冻结 · `D` 升级 · `Q` 撤退 / `X` 出售干员（选中优先，否则操作鼠标指向的干员） · `Space` 准备就绪 · `Esc` 取消 / 关闭；除 `Esc` 外都可以在「设置 → 快捷键」里改成别的键（玩法指南 §11）
方向轮盘键盘操作	方向键预览 · `Enter` 确认 · `Esc` 取消
暂停（独立模拟）	作战中（含最终攻势 / 隐秘核心）点顶栏的「暂停」或按 `Space`，再点「继续作战」（或 `Space`）继续；同盟模拟的作战不能暂停
表情	左下角「交流」，左右滑动（或方向键）换主题，冷却 1 秒
大厅背景与音乐	大厅左上角的图片按钮：四种生成的大厅场景（夜巡 / 霜原 / 烬野 / 静默），或自己的图片 / 视频背景（可调暗度），以及大厅音乐；文件只保存在本机浏览器，不上传，队友看不到
观战	自己的作战结束后（或休整期）点左侧队友头像 →「前往查看」；不参战的朋友可以在大厅点「同盟模拟」、输入同盟密钥后点「观战」（每个同盟最多 2 名观战者，本作新增）
统计（本机）	标题画面右上角、等待室的「统计」，大厅左上角「成就统计」窗口里的「查看完整统计」：胜率、策略通过率、称号、战斗累计和对局记录（点一行回看结算页）；只存在本机浏览器里，可以导出 / 导入，没清完第一个回合就退出的对局不计入统计（玩法指南 §13）
名片干员	等待室里点自己席位卡上的「更换立绘」选一名干员，同盟里的博士都会看到它的立绘；「默认」按博士编号自动分配

sganggs/Stronghold-Protocol

卫戍协议：盟约 · Stronghold Protocol: Alliance

声明

目录

简介

功能一览

快速开始

方式一：整合包（推荐）

方式二：从源码运行

系统要求

端口与配置

和朋友一起玩（局域网）

插件

联机方式

操作

文档

开发与测试

项目结构

许可证

致谢与数据来源

贡献

English

文档	内容
CHANGELOG.md	更新记录：每个版本修复了什么、哪些反馈经核实不是问题
docs/PLAYING.md	玩法指南：流程、经济、招募与晋升、摆阵、联防、盟约、最终攻势、结算称号
docs/PLUGINS.md · docs/PLUGIN-GUIDE.md	插件格式、安装与服主策略；中文工作台入门、DSL 和对战试验
docs/DEPLOY.md	部署指南：Windows 开服与开机自启、防火墙、组网 / 隧道、反向代理与 HTTPS、Docker、systemd、排错
docs/WINDOWS.md	Windows 便携包：怎么打一份「零安装」包（`scripts/make-windows-bundle.mjs`）、包里放了什么、授权注意事项
docs/DESIGN.md	架构与契约（英文）：索引，按章节号找到文件；现行规则在 `docs/design/`（范围与目录分工、坐标与时间、战斗引擎、对局、网络协议、渲染与 UI），各次试玩和各版本的规则修订与依据在 `docs/history/`
docs/ARCHITECTURE.md	代码地图（英文）：服务器、联机协议和前后端共用的战斗模拟，0.2.0 重构后的目录，数据流，黄金结果与导入边界，常见改动从哪里入手
CONTRIBUTING.md	参与贡献：准备环境、运行测试、忠实原则、提交与 PR 约定、怎样添加自选干员（中文，末尾附英文摘要）
docs/SIM.md	战斗模拟引擎参考（英文）：钩子、技能描述格式、职业默认行为
docs/META.md	对局与经济引擎（英文）：回合流程、商店、联防、最终攻势的实现细节
docs/DATA.md	由官方数据表生成的游戏数据（英文）
docs/ASSETS.md	素材来源、目录结构与清单（英文）
docs/I18N.md	界面语言（英文）：界面文字、游戏文本与服务器消息怎样翻译，覆盖范围；添加一种语言只需在 `public/i18n/` 放一个语言文件（社区翻译步骤见「Adding a language」，内容包格式见 docs/PACKS.md）
docs/BALANCE.md	难度模型与测量（英文）
docs/research/	官方规则、数据与界面的调研记录

路径	内容
`server/`	入口 `index.js`；Node HTTP 静态服务 + WebSocket（`/ws`，代码在 `http/`）、大厅、对局引擎（`match/`）、战斗模拟（`sim/`，浏览器与服务器共用）
`shared/`	前后端共用的常量与网络协议
`public/`	浏览器客户端（原生 ES 模块，PixiJS + pixi-spine、three.js 3D 棋盘、Preact + htm UI）
`data/`	由官方数据表生成的游戏数据与素材清单 `assets.json`
`tools/`	`setup.mjs` / `doctor.mjs`、素材下载 `fetch-assets.mjs`、数据构建、本地提取 `local-extract/`
`scripts/`	启动脚本（Windows / macOS / Linux）、Windows 开机自启
`docs/`	文档与调研
`test/`	`node:test` 测试