微端服务器设置说明
本说明介绍用户自定义资源目录、微端端口、客户端鉴权和用户资源 hash 清单的使用方法。 以下设置基于已有的微端配置,请保留原有回源等其他配置。
提示:使用自定义微端服务器前,需要联系管理员,将服务器 IP 加入白名单(过白)。
一、放置用户自定义资源
将自定义数据资源和纹理资源分别放到对应目录,保留资源原有的子目录结构。 例如:
| 资源类型 | 路径示例 |
|---|---|
| 数据资源 | D:/MicroServer/user_data/Map/xxx.map |
| 纹理资源 | D:/MicroServer/user_tex/humaneff4/242/24266.tex |
配置中填写的是资源根目录,不是具体文件路径。 例如,数据目录应填写 D:/MicroServer/user_data/,不要填写到 Map 或 xxx.map。 Data1000 和 Texture1000 是自动生成的清单名称,不需要在用户资源目录下再建立同名文件夹。
二、修改 config.json 配置
在现有 config.json 中找到并修改以下配置项,不要直接用下面的片段替换整个配置文件。 当前版本支持 // 注释。目录路径建议使用正斜杠 /。
// 用户自定义数据资源目录
"user_data_dir": "D:/MicroServer/user_data/",
// 用户自定义纹理资源目录
"user_tex_dir": "D:/MicroServer/user_tex/",
// 微端监听端口,客户端连接此端口
"port": 65002,
// 是否开启客户端票据鉴权
"auth_enable": true,
// 开启鉴权时,必须填写与 LoginSrv 相同的32位微端密钥
"ticket_key": "填写LoginSrv中设置的32位微端密钥"注意:配置项之间需要用逗号分隔,整个 JSON 对象的最后一项不要添加逗号。
三、端口设置
port 是微端对外提供资源下载的 TCP 端口,例如 65002。 客户端的微端连接地址和端口应指向这台微端服务器。 请在服务器防火墙及云服务器安全组中放行该 TCP 端口。 如使用端口映射,还需正确配置对外端口与本机监听端口的映射。
四、鉴权设置
开启鉴权
将 auth_enable 设置为 true,并将 LoginSrv 中设置的微端密钥原样填写到 ticket_key。 两端密钥必须完全一致。请使用支持票据鉴权的客户端和 LoginSrv。 客户端取得票据并通过微端鉴权后,才能下载资源。
关闭鉴权
将 auth_enable 设置为 false,ticket_key 可以设置为空字符串:
"auth_enable": false,
"ticket_key": ""关闭后,微端不校验客户端票据即可提供资源下载。 上述鉴权开关控制客户端资源下载;从服连接主服所需的主服白名单设置仍按原有配置保留。
保存配置后,重启微端服务器生效。
五、自动生成用户资源 hash 清单
微端启动时,会扫描用户自定义目录中的有效资源,自动在运行目录的 hash 文件夹内生成清单:
| 配置项 | 生成清单 |
|---|---|
user_data_dir | hash/Data1000.wpf.hash |
user_tex_dir | hash/Texture1000.wpf.hash |
生成时仅使用用户自定义资源,不读取或合并原始清单,也不修改 res 中的原始清单。 数据和纹理分别处理:某一类用户目录不存在或没有有效资源时,不生成该类清单。 如果该类清单以前生成过,而当前资源已清空,服务器会清理对应的旧清单。
六、将 hash 清单提供给客户端
将生成的 Data1000.wpf.hash 和 Texture1000.wpf.hash 放到客户端原有 .wpf.hash 清单所在的资源目录,和原清单一起使用。 不要删除其他原始清单,也不要修改这两个生成文件的名称。 分发完成后重新启动客户端,使其加载新清单。
清单用于让客户端识别用户资源并请求下载,不是资源文件本身。 实际资源仍需保留在微端配置的用户自定义目录中。
七、后续新增或删除资源
- 在用户自定义目录中新增或删除资源。
- 重启微端服务器,重新建立资源索引并生成最新清单。
- 将最新生成的清单同步给客户端,并重新启动客户端。
- 如果某类资源已全部移除,客户端也需要删除对应的 Data1000.wpf.hash 或 Texture1000.wpf.hash。
注意:hash 清单用于资源路径识别,不是文件内容的更新校验。如果仅替换同一路径下已有文件的内容,更新清单本身不会强制客户端重新下载已经缓存的旧资源。