Skip to content

Latest commit

 

History

History
101 lines (80 loc) · 5.57 KB

README.md

File metadata and controls

101 lines (80 loc) · 5.57 KB
Raw

史学家

《群星》模组，在游戏中自动记录数据，并将其编纂为 HTML 格式的史书。

五帝三皇神圣事，骗了无涯过客。

当前内容

示例见 example 文件夹或 伊尔达联合帝国史。

  • 基本信息

    国家名称，政府名称，政府个性，主流思潮，起源，母星名称，母星类别，母星系名称，创始物种

  • 经济史

    各类资源的储量及月收入

  • 人口史

    • 各物种人口数量
    • 凝聚力储量及月收入

  • 科技史

    • 研究点数月收入
    • 所获科技的名称、描述及获得时间

  • 外交史

    我国与其它国家的关系及相互评价

  • 军事史

    • 海军规模与容量
    • 海军组织
    • 战争

注意：思潮、资源、科技、舰船类型、战争目标等仅记录原版内容，与其它模组的兼容性较差。此外，游戏后期本模组可能会带来较大的性能开销。

未来计划

  • 人口史

    • 各种人口权利在全国人口中的占比
    • 选择的传统和飞升

  • 外交史

    我国与其它国家的外交操作与事件

  • 其它

    • 星球地方志
    • 领袖传记
    • 各事件（局势、异常现象、考古等等）的描述
    • 富语义星图
    • AIGC（文字、图画等）

已知问题

  • 部分舰船类型未能记录。
  • 部分战争类型未能记录（目前使用 on_war_beginning 记录战争，这不适用于某些战争，例如星海共同体与灾飞国家的全面战争）。
  • 部分战争中可能无法完整记录参战国家（目前采用模组指定的 ID 记录国家，每两个月检查一次是否所有与玩家建立通讯的国家都有 ID，如果战争爆发时有的参战国家尚无 ID，则不会被记录到，这种情况常见于机械叛乱）。
  • 部分战争结束时间可能不准确，会延后至多两个月（目前使用 on_war_won, on_status_quo, on_status_quo_forced 记录战争结束，这不适用于某些战争，例如巨像全面战争中将敌人灭国，这种情况下，将以某方成员全被灭国为判断战争结束的标准）。

环境要求

  • OS: Windows 10/11
  • Python 3
    • jinja2
    • pandas

安装

在 Stellaris 模组文件夹（通常为 C:\Users\%USERNAME%\Documents\Paradox Interactive\Stellaris\mod）下的 Powershell 终端中运行如下命令，以下载本仓库文件、创建 Historian.mod 文件、安装所需的 Python 包：

git clone https://github.com/Kaiwen-Zhu/Historian.git
Write-Output ("version=`"0.1.1`"`ntags={`n    `"Utilities`"`n}`nname=`"Historian`"`nsupported_version=`"3.8.*`"`npath=`"$pwd\Historian`"" -replace "\\","/") | Out-File -FilePath Historian.mod -Encoding utf8
cd Historian
pip install -r requirements.txt

注意：由于本模组处于开发阶段，我暂时不会将其上传至创意工坊或推出发行版安装包，使用者需自行搭建 Git、Python 开发环境，若对其不熟悉请参考 使用指南。

使用

使用本模组需要运行两个 Python 脚本（运行方法稍后详细说明）：

  • 每次退出游戏后，运行 src 文件夹中的 extract_history.py，这会从游戏日志中提取数据并写入结构化的数据文件；
  • 想要生成史书时，运行 src 文件夹中的 compile_history.py，这会从 extract_history.py 生成的数据文件中读取数据并编译出 HTML 文档。

生成的数据文件和 HTML 文档会被保存到 Historian 文件夹下的一个单独的文件夹中，该文件夹的名称作为一个参数需要在运行脚本的时候指定（若不指定则为默认值 MemoryGrain）。因此，玩家的每个国家须对应一个独有的文件夹，即，对于一个国家，假设希望将其相关文件保存在名为 地球联合国 的文件夹中，则

  • 第一次运行 extract_history.py 前，应保证 Historian 文件夹下没有名为 地球联合国 的文件夹；
  • 文件夹 地球联合国 将会在第一次运行 extract_history.py 时被自动创建，结档前，不可随意删改或移动该文件夹中的文件；
  • 每次为该国家运行脚本时，该参数都应为 地球联合国。

生成史书后，可点击 地球联合国/output/地球联合国史.html 查看（假设国名为“地球联合国”）。若希望将生成的史书移至别处，需要将 output 这一文件夹作为整体移动，不可单独移出 地球联合国史.html 文件。

以下介绍运行脚本的方法。

  • 运行 extract_history.py

在 Historian 文件夹下的 Powershell 终端运行如下命令。

python ./src/extract_history.py -o "地球联合国"

生成的数据文件将被存储到 ./地球联合国/data。

  • 运行 compile_history.py

在 Historian 文件夹下的 Powershell 终端运行如下命令。

python ./src/compile_history.py -o "地球联合国"

生成的史书将被存储到 ./地球联合国/output。

注意：如果玩家某次退出游戏后没有运行 extract_history.py，那么其信息会在玩家再次进入游戏时 丢失，因为每次进入游戏后游戏日志都会被覆盖。

贡献方式

欢迎对模组创作的任何贡献，包括代码（Stellaris modding API、Python、前端）编写、对史书内容或排版的设计等。如有兴趣可以提出 issue，发送邮件至 [email protected] 或在 QQ 上联系 3387572450。

鸣谢

感谢 Kejing Zhang 对环境搭建的测试、moon-xu37 对文档的审校。