战国 Mod 开发文档

示例索引

仓库里每个示例 Mod 做什么、抄哪个最合适。

示例都在 mods/examples/ 下,每个都是可运行、可读、离线的。 拿不准怎么写某个东西,先看最接近的那个。

按需求找

你要做的事看这个它在哪
写第一个模块hellomods/examples/hello/
从零写一套完整玩法minigamemods/examples/minigame/
加一种资源 / 配方harvestmods/examples/harvest/
加一种内容(大象)elephantsmods/examples/elephants/
换掉一块已有内容teamods/examples/tea/
做一个发行版tea_distmods/examples/tea_dist/
改发行版里的定价fixed_market_pricingmods/examples/fixed_market_pricing/
改发行版里的银行fixed_credit_bankmods/examples/fixed_credit_bank/
做最小可玩发行版playable_minmods/examples/playable_min/
拿掉某个能力no_powermods/examples/no_power/
拿掉某个能力的发行版no_power_distmods/examples/no_power_dist/
只写发行版不改模块recipes_distmods/examples/recipes_dist/
写一个客户端idle_clientmods/examples/idle_client/

逐个说明

hello

最小模块:一个状态、一个工具、两条只读/动作工具。新模块从这里开始抄。

minigame

从零写的一套九模块小规则:三种资源(钱粮木)、一个地形、五种建筑、一个兵种、 宣战与议和、九个模块各管一件事。

  • 装配入口:mods.minigame.toml
  • 配置:"mods": "mods.minigame.toml"
  • 离线可跑完整局:python mp_run.py --config <配置> --new --turns 5
  • 也能用真实模型玩:配置里把 "client": "mini" 换成 "client": "llm" 即可, 发行版不用改一行——这正是发行版与模型客户端解耦的证明。

harvest

加一种资源和配套的产出流程:看「一种新资源要动哪些地方」。

elephants

加一种内容(大象):内容注册、短键、显示名、别名一次讲清。

tea / tea_dist

tea 是模块,tea_dist 是把它装进发行版:看「模块写好了,怎么变成一个发行版」。

fixed_market_pricing / fixed_credit_bank

在不碰模块代码的前提下改发行版参数:看数值覆盖怎么用。

playable_min

最小可玩发行版:比 minigame 更瘦,只演示「发行版清单能有多小」。

no_power / no_power_dist

拿掉一个能力(电力):看「模块化之后,砍掉一个系统要动多少地方」。

recipes_dist

只写发行版、不改模块:用现有模块装出新玩法。

idle_client

一个什么都不做的客户端:看客户端工厂怎么接。

跑一遍全部

.venv/bin/python mods/examples/tour.py

巡礼脚本把《Mod 开发指南》里的每条配方都跑一遍,每步打印可核对的数字。 不联网、不需要 API key、不读写任何真实存档。