概述

这是一个只在服务端生效的 Replay 模组，它允许你在服务器上一次性同时录制多个在线玩家或某一片区块，然后产生一个可以被客户端 Replay 模组使用的录制文件用来渲染。

为什么选择服务端？

与客户端的 Replay Mod 相比，在服务端录制有着许多好处：

• 能够录制固定的区块：

• 你可以指定确切的区块大小（不受服务端视距的影响）；

• 这些记录的区块可以在不影响回放的情况下卸载。

• 区块不会在卸载与加载的过程中闪烁；

• 这些区块也不会被录制器加载（不像 PCRC 一样会手动加载区块）；

• 录制器可以跳过区块被卸载的时间；

• *这里指的是录制器不会手动加载那些本应被卸载的区块（只有当区块被加载时才会进行记录），并且区块的加载与卸载不会对记录产生影响。—— 译者注*

• 能够录制玩家：

• 玩家不需要安装 Replay 模组*（包括此模组和客户端录像回放 Mod。—— 译者注*）；

• 你可以一次性录制多个机位；

• 录制可以依靠设置项自动进行。

• 录制行为可以在任何时间被管理员开启。（或其他有权限的任何人）

但是这仍然有一些缺点和已知问题：

• 一些东西将不会被记录，比如 Boss 栏；

• 要预览录制的回放，你必须从服务端下载录制文件；

• 录制玩家的内容可能不会和客户端 Replay Mod 的录制内容 100% 一致；

• 模组兼容问题。模组可能会和其他一些修改了网络的模组冲突，如果你遇到任何兼容性问题 请提交一个 Github issue。

用法

此模组需要 Fabric Loader、Fabric API 和 Fabric Language Kotlin。

有以下两种方法来在服务端进行录制：你可以对模组进行设置来从玩家的视角跟随并记录玩家；或者，你可以录制固定的一片区块。

快速开始

这部分的文档将会简短地引导你进行基础的构建，同时包含了一些重要的信息。

玩家

要在服务端记录玩家，你可以运行

/replay start players <player(s)>

例如：

/replay start players senseiwells
/replay start players @a
/replay start players @a[gamemode=survival]

玩家录制将会和玩家绑定，并且按服务端视距进行录制。

如果玩家退出了服务器或者服务端停止了，录制将会自动停止并保存。

同时，如果你想要手动停止录制，你可以运行：

/replay stop players <player(s)> <是否保存?>

这个指令还可以停止录制并取消保存，例如：

/replay stop players senseiwells
/replay stop players @r
/replay stop players senseiwells false

此录制之后将会被保存在 "player_recording_path" 所指定的文件夹的玩家 uuid 目录下。

在默认情况下，它将被保存在 ./recordings/players/<uuid>/<date-and-time>.mcpr。

此文件然后可以被放在客户端的 ./replay_recordings 文件夹下，并用客户端录像回放模组打开。

重要通知

如果你要记录 Carpet 的假人，你需要在设置中打开 "fix_carpet_bot_view_distance"，否则只有假人周围的 2 个区块的距离内会被记录。

区块

重要提示：

对于模组录制的指定区域的区块，Minecraft 客户端并不会渲染最边缘的那些区块。所以要记录一片可见的区块，你必须在边缘添加一个区块 （当选取时），例如录制一片从 -5, -5 到 5, 5 的可见区域，你必须从 -6, 6 到 6, 6 进行录制。

要记录服务端的一块区域内的区块，你可以运行：

/replay start chunks from <区块X轴起点> <区块Z轴起点> to <区块X轴终点> <区块Z轴终点> in <维度?> named <名称?>

例如：

/replay start chunks from -5 -5 to 5 5 in minecraft:overworld named MyChunkRecording
/replay start chunks from 54 67 to 109 124
/replay start chunks from 30 30 to 60 60 in minecraft:the_nether

同时你可以指定一个区块和它周围的半径来进行录制：

/replay start chunks around <chunkX> <chunkZ> radius <半径> in <维度?> named <名称?>

例如：

/replay start chunks around 0 0 radius 5
/replay start chunks around 67 12 radius 16 in minecraft:overworld named Perimeter Recorder

区块录制将会被固定并且无法移动，它们将录制指定的区块。需要特别注意的是，当录制开始的时候，这些指定的区块将会被加载一下（并且在有必要的情况下生成）。但在这之后，录制器将不会手动加载这些区块。

同时，如果你希望手动停止录制，你可以运行：

/replay stop chunks from <区块X轴起点> <区块Z轴起点> to <区块X轴终点> <区块Z轴终点> in <维度?> named <名称?>

这个指令还可以停止录制并取消保存，例如：

/replay stop chunks from 0 0 to 5 5 in minecraft:overworld false
/replay stop chunks from 54 67 to 109 124

此录制之后将会被保存在 "player_recording_path" 所指定的文件夹的区块录制器名称下。

在默认情况下，它将被保存在 ./recordings/chunks/<name>/<date-and-time>.mcpr。

此文件然后可以被放在客户端的 ./replay_recordings 文件夹下，并用客户端 Replay Mod 打开。

指令

注意：对于所有的指令，玩家必须要有等级 4 的 OP 权限，或如果你有一个权限模组（例如 LuckPerms，玩家可以在拥有权限节点 replay.commands.replay 时使用这些指令。

/replay enable

允许模组按照给定的规则（详见 [匹配规则](#匹配规则设置) 部分）自动记录玩家。

/replay disable

禁止模组自动录制玩家，这将会同时停止当前的所有的玩家录制和区块录制。

/replay start players <玩家>

手动开启对给定的玩家的录制。

/replay start chunks from <区块X轴起点> <区块Z轴起点> to <区块X轴终点> <区块Z轴终点> in <维度?> named <名称?>

手动开启对给定的区块范围的录制；如果维度没有被指定，将会使用发起指令的玩家所在的维度；名称决定了录制文件的保存路径。

/replay start chunks around <区块X轴位置> <区块Z轴位置> radius <半径> in <维度?> named <名称?>

该指令和上一个指令类似；但你可以指定录制给定区块周围的半径内的区域。

/replay stop players <player(s)> <是否保存?>

手动停止对给定玩家的录制，你可以选择性地设置录制是否被保存，默认情况下它将会被保存。

/replay stop chunks from <区块X轴起点> <区块Z轴起点> to <区块X轴终点> <区块Z轴终点> in <维度?> named <名称?>

手动停止对于给定区块范围的录制。如果维度没有被指定，将会使用发起指令的玩家所在的维度。

你可以选择性地设置录制是否被保存，默认情况下它将会被保存。

/replay stop chunks named <名称> <是否保存?>

该指令和上一个指令类似；但你可以依靠名称来选取指定的区块范围。

/replay stop [chunks|players] all <是否保存?>

手动停止对所有区块或玩家的录制。你可以选择性的设置录制是否被保存，默认情况下它将会被保存。

/replay status

获取一个状态信息，包含录制是否被允许，以及当前所有对玩家和区块的录制的列表，它们已被录制的时长，和它们的文件大小。

/replay reload

重载 Replay 模组的配置文件。

配置项

在你启动服务器后，一个新的文件将会生成在 ./config/ServerReplay/config.json，默认情况下它是这样的：

{
  "enabled": false,
  "world_name": "World",
  "server_name": "Server",
  "chunk_recording_path": "./recordings/chunks",
  "player_recording_path": "./recordings/players",
  "max_file_size": "0GB",
  "restart_after_max_file_size": false,
  "max_duration": "0s",
  "restart_after_max_duration": false,
  "recover_unsaved_replays": true,
  "include_compressed_in_status": true,
  "fixed_daylight_cycle": -1,
  "pause_unloaded_chunks": false,
  "pause_notify_players": true,
  "notify_admins_of_status": true,
  "fix_carpet_bot_view_distance": false,
  "ignore_sound_packets": false,
  "ignore_light_packets": true,
  "ignore_chat_packets": false,
  "ignore_scoreboard_packets": false,
  "optimize_explosion_packets": true,
  "optimize_entity_packets": false,
  "record_voice_chat": false,
  "player_predicate": {
    "type": "none"
  },
  "chunks": []
}

/replay reload

/replay [enable|disable]

/replay status

/replay status

区块设置

你可以定义当服务端启动或你启用了 ServerReplay 时，要被自动录制的区块区域。

每一个区块的定义必须包含："name"，"dimension"，"from_x"，"to_x"，"from_z"，和"to_z"。例如：

{
  // ...
  "chunks": [
    {
      "name": "My Chunks",
      "dimension": "minecraft:overworld",
      "from_x": -5,
      "from_z": -5,
      "to_x": 5,
      "to_z": 5
    },
    {
      "name": "My Nether Chunks",
      "dimension": "minecraft:the_nether",
      "from_x": 100,
      "from_z": 50,
      "to_x": 90,
      "to_z": 60
    }
    // ...
  ]
}

匹配规则设置

其实这个东西应该叫“断言”。

你可以定义一个匹配规则，它将决定服务端上要被自动录制的玩家。 你可以通过指定某个玩家是否有特定的 uuid，名字，在某个特定的队伍里，或是否是一个管理员，来设置此规则。

最基本的选项是记录所有玩家，在这种情况下，您可以使用：

{
  // ...
  "player_predicate": {
    "type": "all"
  }
}

如果你想要只记录带有特定名字或 uuid 的玩家，你可以使用：

{
  // ...
  "player_predicate": {
    "type": "has_name",
    "names": [
      "senseiwells",
      "foobar"
    ]
  }
}

{
  // ...
  "player_predicate": {
    "type": "has_uuid",
    "uuids": [
      "41048400-886d-497d-9d97-9fe7c9b63afa",
      "71266dbd-db0a-484a-b859-3f135590d7a9",
      "47d072ca-d7a2-467c-9b60-de501907e91d",
      "0e324e7f-e78e-4777-b501-7ae08a65b1eb",
      "7d9e24c2-9d0f-479f-81c7-27389624ebb2"
    ]
  }
}

如果你只想要记录管理员：

{
  // ...
  "player_predicate": {
    "type": "has_op",
    "level": 4
  }
}

如果你只想要记录在特定队伍中的玩家，这一选项可以支持玩家在游戏中被加入或移除队伍，因此你可以只玩家加入队伍，然后让他们重新登录（来自动记录该玩家 —— 译者注）。

{
  // ...
  "player_predicate": {
    "type": "in_team",
    "teams": [
      "Red",
      "Blue",
      "Spectators"
    ]
  }
}

你还可以使用否定规则，用 not 然后用 or 和 and 连接。 例如，如果你想要记录非管理员且玩家名不为 senseiwells 的玩家，或在红队中的玩家：

{
  // ...
  "player_predicate": {
    "type": "and",
    "predicates": [
      {
        "type": "not",
        "predicate": {
          "type": "has_op",
          "level": 4
        }
      },
      {
        "type": "not",
        "predicate": {
          "type": "or",
          "predicates": [
            {
              "type": "has_name",
              "names": [
                "senseiwells"
              ]
            },
            {
              "type": "in_team",
              "teams": [
                "Red"
              ]
            }
          ]
        }
      } 
    ]
  }
}

如果你正在使用 Carpet 模组且能够召唤假人，你可能会想让假人不被自动记录。 你可以使用 is_fake 条件来实现：

{
  // ...
  "player_predicate": {
    "type": "not",
    "predicate": {
      "type": "is_fake"
    }
  }
}

开发者

如果你想要玩家被记录时的更多的控制权，你可以在你的模组中接入此方法。

要在你的项目中接入 API，你可以下面内容加入你的 build.gradle.kts 中：

repositories {
    maven {
        url = uri("https://jitpack.io")
    }
}
dependencies {    // For the most recent version use the latest commit hash
    modImplementation("com.github.Senseiwells:ServerReplay:281e9e0ec0")
}

这里有一个最基本的例子：

class ExampleMod: ModInitializer {
    override fun onInitialize() {
        ServerPlayConnectionEvents.JOIN.register { connection, _, _ ->
            val player = connection.player
            if (!PlayerRecorders.has(player)) {
                if (player.level().dimension() == Level.END) {
                    val recorder = PlayerRecorders.create(player)
                    recorder.tryStart(log = true)
                }
            } else {
                val existing = PlayerRecorders.get(player)!!
                existing.getCompressedRecordingSize().thenAccept { size ->
                    println("Replay is $size bytes")
                }
                existing.stop(save = false)
            }
        }

        ServerLifecycleEvents.SERVER_STARTED.register { server ->
            val recorder = ChunkRecorders.create(
                server.overworld(),
                ChunkPos.ZERO,
                ChunkPos(5, 5),
                "Named"
            )
            recorder.tryStart(log = false)
        }
    }
}