# SCAPI-AI-DOCS

**Repository Path**: p0_INT32/scapi-ai-docs

## Basic Information

- **Project Name**: SCAPI-AI-DOCS
- **Description**: AI生成的SCAPI文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-11
- **Last Updated**: 2026-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Survivalcraft API 模组开发文档

> 基于 SCAPI 1.9（C#，.NET 10，HarmonyX 2.2.2，OpenGL ES 3.2）。
>
> 文档采用 **架构优先（Architecture-first）** 写作风格：先解释系统设计目标与运行时架构，再展开实现细节。

## 文档索引

### 入门
| # | 文档 | 核心内容 |
|---|------|----------|
| 01 | [快速开始](01-快速开始.md) | 环境搭建、第一个模版项目、模组加载流程 |
| 02 | [项目结构](02-项目结构.md) | SCMOD 文件结构、Assets 目录约定、构建与部署 |

### 核心系统
| # | 文档 | 核心内容 |
|---|------|----------|
| 03 | [ModLoader 系统](03-ModLoader系统.md) | 游戏生命周期钩子、方块/渲染/UI 钩子、钩子通信机制 |
| 04 | [Block 系统](04-Block系统.md) | Block 类层次、创建方块、BlockBehavior、掉落、动态 ID |
| 05 | [Component 和 Subsystem](05-Component和Subsystem.md) | ECS 架构、Component 与 Subsystem 职责、实体管理 |
| 06 | [UI 系统](06-UI系统.md) | Widget 树、Measure-Arrange 布局、Screen/Dialog、事件模型 |
| 07 | [配方系统](07-配方系统.md) | 配方类型、.cr 文件格式、动态添加/删除、材料映射 |
| 08 | [动态方块 ID](08-动态方块ID.md) | 动态 ID 分配机制、兼容性处理、Index 与数据值 |

### 高级功能
| # | 文档 | 核心内容 |
|---|------|----------|
| 09 | [HarmonyX 注入](09-HarmonyX注入.md) | Prefix/Postfix/Transpiler、运行时 IL 织入、条件补丁 |
| 10 | [地形生成](10-地形生成.md) | TerrainBrush、OnTerrainContentsGenerated 钩子、生物生成 |
| 11 | [数据文件格式](11-数据文件格式.md) | .csv/.cr/.xdb/.json/.xml 格式规范与文件路径约定 |

### 工具类参考
| # | 文档 | 核心内容 |
|---|------|----------|
| 12 | [Engine 工具类](12-Engine工具类.md) | Vector3/Matrix/Color/MathUtils/Log/Time 等基础工具 |
| 13 | [Game 工具类](13-Game工具类.md) | Terrain/BlocksManager/Project/常用 Component/Subsystem |

### 架构分析与模式
| # | 文档 | 核心内容 |
|---|------|----------|
| 14 | [完整示例解析：架构模式分析](14-完整示例解析.md) | 泰拉工作台/仇恨棍/思维加载器的架构设计与协作模式 |
| 15 | [Engine 绘图工具库](15-Engine绘图工具库.md) | PrimitivesRenderer、FlatBatch、Model 骨骼系统、渲染管线 |
| 16 | [覆盖原版数值](16-覆盖原版内容的完整指南.md) | xdb/csv/HarmonyX 三种修改方法的架构与决策流 |

### 生物系统与原版总览
| # | 文档 | 核心内容 |
|---|------|----------|
| 17 | [生物与实体系统](17-生物与实体系统.md) | Creature 生命周期、核心组件、行为系统、每帧更新流 |
| 18 | [原版组件与界面总览](18-原版组件与界面总览.md) | 所有原版 Component/Behavior/Dialog/Screen/Widget 分类索引 |

### 实战示例

详见 [示例/README.md](示例/README.md)。包含 11 个独立示例文件，覆盖 BFS 搜索、配方处理、异步初始化、方块行为、GUI 交互、数据覆盖等场景。

### 官方技术文档

| 文档 | 用途 |
|------|------|
| [Development.md](官方文档/Development.md) | 环境配置、构建指南、调试方法 |
| [Architecture.md](官方文档/Architecture.md) | 项目整体架构和运行机制 |
| [UiSystem.md](官方文档/UiSystem.md) | Measure-Arrange 布局机制、容器组件实现 |
| [TerrainSystem.md](官方文档/TerrainSystem.md) | 地形系统架构、核心机制、数据结构 |
| [CreatureModelSystem.md](官方文档/CreatureModelSystem.md) | 3D 模型数据结构、骨骼动画、渲染流程 |
| [ModInfoConfig.md](官方文档/ModInfoConfig.md) | 模组配置文件 JSON 参数含义和填写规范 |
| [HowToDevelopAMod.md](官方文档/HowToDevelopAMod.md) | 从环境准备到模组制作的全流程指导 |

## 学习路线

```
新手：01 → 02 → 03 → 04 → 11
进阶：05 → 07 → 06 → 09 → 18
高级：10 → 08 → 14 → 15 → 16 → 17
```

## 技术栈

- **语言**: C# (.NET 10)
- **图形**: OpenGL ES 3.2 (Silk.NET)
- **平台**: Windows / Linux / Android / iOS / Browser
- **模组系统**: HarmonyX 2.2.2

## 版本

- **当前文档版本**: SCAPI 1.9
- **动态方块 ID**: API 1.8+ 新增
- **重要变更**: 与 1.44/1.5 等旧版 API 存在差异