CCA网络协议

它有什么用?

开启本功能后, CCA会拿到加入服务器玩家客户端的mod信息.并加以利用实现了一个mod黑名单

它有一个给其他mod的接口(Mcdreforged也可以通过一些方法拿到这个接口提供的一些信息) 这会在后面说明

它如何使用

旧版CCANetworkProtocol已弃用

如果你在寻找旧版CCANetworkProtocol(CCA-v1.3.0之前)的文档, 它在这里

在你服务器第一次启动后, 它会生成一个配置文件, 它的路径看起来是这样的<YourServer>\config\CrystalCarpetAddition\CrystalCarpetAddition.json

里面的内容是这样的

{
  "Version": 1,
  "BlackPackages": [],
  "PrintModList": false,
  "Kick": true
}

Version是配置文件版本号, 供内部识别使用, 你不需要修改它

BlackPackages是一个数组, 用于填写你要禁用mod的id和用于识别的ClassValue

格式为: <modId>$<ClassValue>, 它需要满足正则表达式^(.{1,63}\$).+

例如需要禁用cca和tis-carpet, 你可以这么填写(只是一个例子, 不要禁用cca, 否则玩家会无法加入游戏)

"BlackPackages": [
  "cca$crystal0404.crystalcarpetaddition.CrystalCarpetAdditionMod",
  "carpet-tis-addition$carpettisaddition.CarpetTISAdditionMod"
]

PrintModList, 设置为true会在控制台和日志中打印玩家的mod信息

Kick, 设置为true, 如果客户端无法接收CCANetworkProtocol的数据包, 会被踢出服务器

这是一个正确填写的例子

{
  "Version": 1,
  "BlackPackages": [
    "cca$crystal0404.crystalcarpetaddition.CrystalCarpetAdditionMod",
    "carpet-tis-addition$carpettisaddition.CarpetTISAdditionMod"
  ],
  "PrintModList": false,
  "Kick": true
}

如果填写错误, 可能会造成游戏无法启动

如何寻找ClassValue

简单且绝大部分时刻有效的方法:

将mod解压, 打开其中的 fabric.mod.json
找到键 entrypoints
从其中 main或者client 数组中随便挑选一个就可以了

上面方法不奏效:

将mod解压
找到任意一个以 .class为拓展名的文件
复制文件完整的路径到记事本
删除与 fabric.mod.json同级和前面的路径的字符串
删除 .class
把所有的路径分割符合换成 .
如果没有按预期工作, 就换一个文件重复上述步骤

其它问题

在1.20.2以下的群组服环境中, 代理会丢弃登录阶段的玩家信息, 这会导致CCA的数据包无法发送, 模组黑名单功能从而无法正常工作. 但是回调接口和打印客户端mod列表的功能(应该)是正常的.

如果黑名单无法正常工作, 很可能会出现所有人都无法进入服务器, 请在CrystalCarpetAddition.json中把Kick设置为false, 玩家即可正常进入服务器(黑名单不会工作)

回调接口

(如果你不是开发者, 快跑, 这里有龙)

如果你坚持留了下来, 那我们继续

CCANetworkProtocol提供了一个回调接口GetClientModMap可供其它mod来获取玩家加入游戏时的客户端mod列表

要想使用它, 你需要先实现CCA的接口并重写其中的方法

示例:

//...
import crystal0404.crystalcarpetaddition.api.CCANetorkProtocol.GetClientModMap;
import net.minecraft.server.MinecraftServer;
import net.minecraft.server.network.ServerPlayNetworkHandler;
import net.minecraft.server.network.ServerPlayerEntity;

import java.util.HashMap;

public class getClientMod implements GetClientModMap {
    @Override
    public void getMod(MinecraftServer server, ServerPlayerEntity player, ServerPlayNetworkHandler handler, HashMap<String, String> modMap) {
        // Do sth
    }
}

然后你需要注册它, 让CCA知道这个接口的存在

你需要服务端入口点(即实现了DedicatedServerModInitializer接口重写的方法)调用CCANetworkProtocolAPI.register()来注册你的接口

示例:

//...
import crystal0404.crystalcarpetaddition.api.CCANetorkProtocol.CCANetworkProtocolAPI;
import net.fabricmc.api.DedicatedServerModInitializer;

public class server implements DedicatedServerModInitializer {
    @Override
    public void onInitializeServer() {
        CCANetworkProtocolAPI.register(new getClientMod());
    }
}

(记得在fabric.mod.json里注册你的服务端入口点)

一个mod只需注册1次, 不要重复注册, 否则可能会导致OOM

现在只要开启了CCANetworkProtocol并且客户端也安装了CCA和fabric-api, 玩家加入游戏时这个接口就会被调用, modMap是一些键值对, 键是modId, 值是mod的版本.

除此之外, CCA其它的方法和接口均不是对外公开的, 不要去调用它们.

CCA网络协议

它有什么用?​

它如何使用​

如何寻找ClassValue​

其它问题​

回调接口​

它有什么用?

它如何使用

如何寻找ClassValue

其它问题

回调接口