📚 扩展文件参考

沙盘引擎 程序及模组目录内包含许多文件，本文将列出部分关键文件进行说明介绍。

📒 Mod.JSON 配置文件

此文件放置每个模组的独立配置项，此文件应保持存在且有效。

📘 配置示例

{
	"Name": "Introduce&Demo",
	"Author": "SandtableEngine",
	"Info": "SandtableEngine official introduce demo",
	"Version": "1.0",
	"Font": "TsangerYuYangT",
	"DefaultLanguage": "English",
	"Website": "mp-gamer.com",
	"NetworkPort": 8192,
	"NetDownload": true,
	"LastTime": "0" //Auto
}

📘 配置项说明

📒 Local.JSON 配置文件

此文件放置每个模组的独立本地配置项，引擎每次载入模组后自动生成及修改。

此文件通常保存非关键的记录信息，例如：上次载入时间、上次主机UUID等。

📘 配置项说明

📒 Startup.JSON 配置文件

此文件为模组可选的附带文件，允许为模组提供一些前置文本数据。

文件作用：允许开发者通过GetGlobalVars("Startup")获取此文件内的所有文本（内容只读，且文本内容不限于json格式，即使内部是一串诗歌也没有问题）。

通过此属性的机制，开发者可扩展实现许多前置功能（例如：专用服务端的前置配置，房间名、端口号、房间最大人数等）。

📘 简单示例

沙盘引擎 默认没有提供专用服务器的启动配置文件。

这就导致专用服务器建立的服务器无法获取自定义配置，开发者可能希望制作一个json | txt表的方式，以在每次建立专用服务器时模组知道该如何设置服务器名称、最大人数，自定义端口等配置。

如果有其他类似的相关需求，均可以利用此机制来做前置配置文件。

📘 示例步骤

1. 在模组根目录建立或打开Startup.json文件，准备修改

2. 将此文件内容修改成自己可解析的模式，这里可以使用json文本方式，根据需求自行编写一套数据表

   {
       "HostName": "Sandtable Engine Server",
       "Map": "helloworld",
       "MaxPlayers": 100,
       "Password": "",
       "RconPassword": ""
   }

3. 确认正确编写后，在Main场景的启动事件中，使用GetGlobalVars("Startup")获取到Startup.json内的文本信息，并转成自己想要的格式（如果是标准json文本，则会自动反序列化）

4. 使用获取后的内容，按需求来编写逻辑代码

   function OnScriptLoad()
   {
       if(IsServerMode())
       {
           //因为示例是json文本，所以会自动序列化，可直接使用属性
           let startup = GetGlobalVars("Startup");
           DLog(startup.HostName); //"Sandtable Engine Server"
       }
   }

5. 因为GetGlobalVars()是模组全局生效的，所以可以在不同场景一直使用

📘 其他补充

• 相关API：SetGlobalVars()不可写入Startup的内容，这是只读的

• 如果有特殊需求，Startup类文件可以同时在Mod目录存在多个，可在启动时使用启动参数-startup_XX进行重定义

• 启动参数：-startup_XX可用于在启动游戏时指定运行Mod目录下的其他文件，最终作为模组Startup的重定向读取

📒 Script/_Config.JSON 配置文件

此文件通常位于模组脚本子目录内，用于配置此脚本目录的相关前置选项。

此配置文件是可选的，如果不需要相关功能，可以删除此文件。

📘 配置示例

{
	"DefaultMap": "",
	"Plugins": [
		"PlayerCharacterTag",
		"PlayerCharacterMarker",
		"AdminSystem"
	]
}