From 892f672618a391c610f07393f10664d243fc97ff Mon Sep 17 00:00:00 2001 From: kuxiaowo <1127944431@qq.com> Date: Fri, 23 Oct 2026 19:59:30 +0800 Subject: [PATCH 1/2] docs: add Simplified Chinese README --- README.md | 2 ++ README.zh-CN.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 README.zh-CN.md diff --git a/README.md b/README.md index aec0447..e6d849e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # StarMap +[简体中文](README.zh-CN.md) + A POC/Prototype arbitrary code modloader for Kitten Space Agency. Currently this loader can be ran with this functionality in the background, or as a dumb loader just loading mods. It makes use of Assembly Load Contexts to ensure mod dependencies are managed seperatly, reducing conflicts diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..9b47e71 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,39 @@ +# StarMap + +[English](README.md) | 简体中文 + +StarMap 是用于 Kitten Space Agency 的概念验证（POC）/原型代码模组加载器，可加载自定义代码。 +目前，加载器既可在后台运行，也可作为仅负责加载模组的简单加载器使用。 +它使用程序集加载上下文（Assembly Load Contexts）分别管理模组依赖，以减少冲突。 + +## 安装 + +- 从 [Releases](https://github.com/StarMapLoader/StarMap/releases/latest) 下载并解压发布包。 +- 首次运行 `StarMap.exe` 时会因缺少配置而无法启动游戏，并生成 `StarMapConfig.json`。 +- 打开 `StarMapConfig.json`，设置 KSA 的安装位置。 + - `GameLocation` 应直接指向 Kitten Space Agency 的安装目录（例如 `C:\\games\\Kitten Space Agency\\`）。 + - `RepositoryLocation` 可以留空。 +- 再次运行 `StarMap.exe`，此时应能启动 KSA 并加载模组。 + +## 模组位置 + +模组可以放在以下任一位置： + +- `Documents/My Games/Kitten Space Agency/mods//`（推荐；游戏更新后仍可保留） +- `/Content//` + +StarMap 使用游戏的清单（manifest）系统，从这两个位置发现模组。 + +## 模组开发 + +有关模组开发的更多信息，请参阅示例模组仓库：[StarMap-ExampleMods](https://github.com/StarMapLoader/StarMap-ExampleMods)。 + +## 未来计划 + +目标是提供类似《异星工厂》（Factorio）的模组使用体验：玩家可在游戏内从远程仓库选择模组，游戏自动重启后安装这些模组。 +目前，加载器通过两个进程单独运行游戏，以便重启游戏。 +设想中的仓库仅提供模组、版本和下载地址的索引；实际下载文件存放在其他位置，例如 GitHub Releases。 + +## 致谢 + +- Lexi - [KSALoader](https://github.com/cheese3660/KsaLoader) From f2b53ffac161f2ba699222441252392ff00f49f4 Mon Sep 17 00:00:00 2001 From: kuxiaowo <1127944431@qq.com> Date: Mon, 26 Oct 2026 16:52:10 -0700 Subject: [PATCH 2/2] docs: sync Chinese README with current upstream requirements --- README.zh-CN.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.zh-CN.md b/README.zh-CN.md index 9b47e71..c209029 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -6,9 +6,20 @@ StarMap 是用于 Kitten Space Agency 的概念验证（POC）/原型代码模 目前，加载器既可在后台运行，也可作为仅负责加载模组的简单加载器使用。 它使用程序集加载上下文（Assembly Load Contexts）分别管理模组依赖，以减少冲突。 +## 文档 + +[StarMap 文档](https://starmaploader.github.io/StarMap/)介绍了安装、使用和模组开发，Markdown 源文件位于 [`docs`](https://github.com/StarMapLoader/StarMap/tree/main/docs/) 目录。 + +## 发布 + +如需发布版本，请在要发布的提交上创建并推送语义化版本标签，例如 `1.2.3`。发布工作流会从该提交构建发布包和安装程序；标签可以指向任意分支上的提交。 + +文档站点跟随当前发布版本更新，不为旧版本保留独立的文档快照。当前候选发布版的文档可在 [RC 文档站点](https://starmaploader.github.io/StarMap/rc/)查看。 + ## 安装 - 从 [Releases](https://github.com/StarMapLoader/StarMap/releases/latest) 下载并解压发布包。 +- 如果尚未安装，请先安装 Windows x64 版 [.NET 10 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)。 - 首次运行 `StarMap.exe` 时会因缺少配置而无法启动游戏，并生成 `StarMapConfig.json`。 - 打开 `StarMapConfig.json`，设置 KSA 的安装位置。 - `GameLocation` 应直接指向 Kitten Space Agency 的安装目录（例如 `C:\\games\\Kitten Space Agency\\`）。