FKEscape / DOCS

Appearance

从零安装 ​

本页只介绍 FKEscape 自身的安装。请先准备好 Paper 群组服、一台大厅服、至少一台游戏服、MySQL 和可正常切换子服的代理。

1. 安装前置插件 ​

把 FKEscape 使用到的前置插件安装到对应 Paper 子服。常用前置包括：

  • Vault 与一个受支持的经济插件
  • PlaceholderAPI
  • Citizens（需要 NPC 入口时）
  • MythicMobs、MMOItems、MythicLib（使用对应怪物、物品和属性功能时）

依赖插件安装完成并确认无报错后，再安装 FKEscape。

2. 放入插件 ​

将同一个 FKEscape JAR 放入大厅服和所有游戏服的 plugins 目录，然后分别启动一次服务器。插件会自动生成配置文件。

首次启动后关闭服务器，再开始修改配置。不要在服务器运行时直接覆盖整个配置目录。

3. 配置 MySQL ​

FKEscape 会自动创建所需的数据库和数据表，不需要手动执行 SQL。

请准备一个可连接 MySQL、并拥有创建数据库和数据表权限的账号，然后在每台子服的 settings.yml 中填写相同的连接信息：

yaml
database:
  mysql:
    host: 127.0.0.1
    port: 3306
    database: fkescape
    username: fkescape
    password: 请替换为实际密码

如果 MySQL 位于另一台机器，把 host 改为实际内网地址，并确保防火墙允许各子服连接。不要把数据库端口直接开放给公网。

4. 设置服务器角色 ​

大厅服：

yaml
server-role: LOBBY
server-id: lobby
lobby-server: lobby

第一台游戏服：

yaml
server-role: GAME
server-id: game-1
lobby-server: lobby
game-world: world

game-world 必须填写真实存在且已经加载的世界名。多台游戏服的部署方式见多服部署。

5. 配置玩法 ​

按以下顺序调整配置最容易排查问题：

  1. 在 settings.yml 设置匹配人数、各阶段时间和服务器信息。
  2. 在 zones.yml 设置出生区域、战利品区域和 Boss 区域。
  3. 在 extraction.yml 设置撤离点。
  4. 在 loot.yml 配置容器位置和战利品。
  5. 在 kits.yml、shop.yml 和背包相关文件中配置装备与商店。
  6. 最后调整伤势、增益、语言和 CustomModelData。

每个文件的字段和完整示例都可以在配置文件参考中查看。

6. 启动并检查 ​

建议按以下顺序启动：MySQL、大厅服、游戏服。代理只需确保玩家能够在已有子服之间正常切换，不需要为 FKEscape 编写额外配置段。

启动后检查控制台：

  • 所有前置插件均已加载。
  • FKEscape 已成功连接 MySQL。
  • 没有 YAML 格式错误或配置引用错误。
  • 大厅服和游戏服显示了正确的服务器角色。

7. 完整测试 ​

使用普通玩家账号依次测试：

  1. /fkescape 能显示帮助。
  2. /fkescape shop 能打开商店。
  3. /fkescape join 能报名并进入游戏服。
  4. 能选择装备、打开背包、搜刮物品并进入撤离点。
  5. 成功撤离后能返回大厅，并通过 /fkescape mailbox 领取物品。
  6. 死亡、主动离开和断线时不会把本局未撤离物品带回大厅。

正式开放前建议完成上线检查清单。

修改配置后如何生效 ​

大部分玩法配置可通过以下命令重新加载：

text
/fkescape admin reload

数据库连接、服务器角色、服务器名称和游戏世界等基础设置修改后，应重启对应子服。