From 929a26f03d7ad07aa571467213130ba40e140052 Mon Sep 17 00:00:00 2001
From: TONY_All <admin@minicraft.top>
Date: Sun, 20 Mar 2022 15:42:42 +0800
Subject: [PATCH] add README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..509fbc2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# 给屑颜的留言
+
+该插件使用 PaperSpigot 在 1.18 中提供的 paperweight-userdev 工具包进行开发，Gradle 任务 runServer 可用于直接在Idea内启动简易服务端用于插件测试。
+
+## `cc.maxmc.sample.packet` 
+该部分为数据包拦截原理，我做的简易实现，实际开发过程中建议使用`ProtocolLib/TabooLib`等成熟数据包收发框架进行处理
+
+## `cc.maxmc.sample.listener`
+该部分为聊天信息截取，在Paper中该数据包
+
+`net.minecraft.network.protocol.game.ClientboundChatPacket#getMessage` 用于发送系统信息(主要为TranslateKey)
+
+`net.minecraft.network.protocol.game.ClientboundChatPacket.adventure$message` 用于发送玩家聊天信息
+
+`net.minecraft.network.protocol.game.ClientboundChatPacket.components` **可能**用于插件发送消息
+