说明：本描述为中英双语版本，中文内容位于英文内容下方。
Note: This description is bilingual. The Chinese section is provided below the English section.

---

Romestead Content Framework (English)

A dependency framework for Romestead content mods, focused on items, crafting, jobs and player-built buildings. It connects mod content to the game's existing systems through a shared registration API.

For Players

Install this framework when a content mod lists it as a requirement. The framework alone does not add other playable content; install those content mods separately.

Main Features

• Register items, equipment and consumables, backpack recipes and their unlock conditions.
• Add jobs and work recipes with job-level groups, ingredients, outputs and experience.
• Register player-built buildings, construction groups, upgrades, crafting stations, furniture and decorations.
• Use standard building behavior for worker-driven production or timed item production, with storage and output inventories.
• Load custom CMX/TMX building maps and their CDB/CDX/PNG doodad resources.
• Add items to shops and drop tables.
• Register PNG icons, sprite VFX and simple custom spell/effect callbacks.
• Reapply registered content after the corresponding game databases are rebuilt.

The framework focuses on player-usable content. POIs, quests, terrain generation, bosses and other world-authoring systems are outside its scope.

Romestead Content Browser

The archive includes Romestead Content Browser, an offline reference page for mod authors. Extract the archive and open RomesteadContentBrowser/index.html in a web browser. When using a mod manager, locate that file in the installed package folder.

The browser requires no running game or framework installation.

• Browse and search vanilla item IDs, recipes, jobs, work recipe groups, shops, drop tables, world flags, spells, icon IDs, sprite VFX IDs and localization keys.
• Switch between English and Chinese.
• The included page contains a Romestead 0.26.2_4 data snapshot. It does not update itself when the game updates.
• Sound, SPAC VFX and projectile-display entries list references used by spells; they are not complete resource libraries.
• The page does not include game textures, audio or visual asset previews. A listed vanilla ID does not imply that the framework provides an API for registering that entire system.

The browser is an authoring reference and can be removed without affecting the framework. On Nexus Mods, it is offered as a separate Optional File. On Thunderstore, it is included in this package.

For Mod Authors

• Complete example mod: Romestead Content Framework Example Mod
• Use RomesteadContentFramework.Api.RomesteadContent to register content during your plugin's Load(). Use stable IDs with your mod's own namespace, and distribute custom maps and resources with your content mod.
• This framework uses the game's existing behavior where supported; it does not provide a complete SDK for every game system.

Important Notes

• For single-player or client-hosted games, install the normal Romestead Content Framework mod on the game client.
• For a dedicated server, install Romestead Content Framework Server on the dedicated server, and have players install the normal Romestead Content Framework mod.
• Server and client mod versions and logistics settings should match in multiplayer.
• Content mods can store IDs in saves. Back up your saves before removing a content mod or this framework from a world that uses its content.

Bug Reports & Feature Suggestions

Please submit reports through GitHub Issues, or contact [email protected] or [email protected].

---

Romestead Content Framework (中文)

面向 Romestead 内容模组的前置框架，重点支持物品、制作、职业和玩家建筑。通过统一的注册 API，将模组内容接入游戏已有系统。

给玩家

当内容模组将本框架列为前置时安装即可。框架本身不会添加可玩内容，这些内容需要单独安装对应模组。

主要功能

• 注册物品、装备、消耗品、背包制作配方及其解锁条件。
• 添加职业和工作配方，支持职业等级分组、材料、产出和经验。
• 注册玩家建筑、建造分组、建筑升级、工作台、家具和装饰。
• 使用标准建筑行为实现工人工作订单生产或定时物品生产，并接入仓储与产出库存。
• 加载自定义 CMX/TMX 建筑地图及其 CDB/CDX/PNG doodad 资源。
• 向商店和掉落表添加物品。
• 注册 PNG 图标、精灵特效和简单自定义法术/效果回调。
• 在对应游戏数据库重建后，重新应用已注册的内容。

框架面向玩家可用内容。POI、任务、地形生成、Boss 等世界内容制作系统不在范围内。

Romestead Content Browser 内容浏览器

压缩包内包含供模组作者使用的 Romestead Content Browser 离线参考网页。解压后，用网页浏览器打开 RomesteadContentBrowser/index.html。使用模组管理器安装时，可在已安装模组的包目录中找到该文件。

打开浏览器不需要运行游戏或安装框架。

• 可浏览、搜索原版物品 ID、配方、职业、工作配方组、商店、掉落表、世界旗帜、法术、图标 ID、精灵特效 ID 和本地化键。
• 支持中英文切换。
• 随包网页使用 Romestead 0.26.2_4 的数据快照，不会随游戏更新自动刷新。
• 音效、SPAC 特效和弹射物显示栏目仅列出法术引用，并非完整资源库。
• 网页不包含游戏贴图、音频或视觉资源预览。网页列出某个原版 ID，不代表框架支持注册该系统的全部内容。

浏览器是制作模组时的参考工具，删除网页不会影响框架运行。Nexus Mods 将其作为独立 Optional File（可选文件） 提供；Thunderstore 则直接包含在本模组压缩包内。

给模组作者

• 完整例子模组：Romestead Content Framework Example Mod
• 在插件的 Load() 中，通过 RomesteadContentFramework.Api.RomesteadContent 注册内容。内容 ID 使用自己模组的稳定命名空间，自定义地图和资源随内容模组分发。
• 框架在已支持的范围内复用原版行为，不是覆盖游戏所有系统的完整 SDK。

重要说明

• 单人游戏或本机开服游玩时，在游戏客户端安装普通版 Romestead Content Framework。
• 专用服务器需要在服务器上安装 Romestead Content Framework Server，并让玩家安装普通版 Romestead Content Framework。
• 多人游戏中，服务器和客户端的模组版本与物流设置建议保持一致。
• 内容模组可能将 ID 写入存档。从使用了这些内容的世界中移除内容模组或框架前，请备份存档。

Bug 提交 & 新功能建议

请通过 GitHub Issues 提交，或通过邮箱 [email protected]、[email protected] 联系。