为 Minecraft 基岩版提供协议读写支持
开源地址
注意：
本项目不是任何加载器的插件，与 LeviLamina、Endstone 等没有任何关系！
本项目是一个静态库，是面向开发者的项目！
QQ交流群：1063182638
[MD] # 📄 Protocol    [📄 English README](README.md) 一个基于 C++23 的 Minecraft 基岩版网络协议库。 Protocol 提供基岩版数据包模型、数据包 ID 映射，以及二进制读写工具， 可用于构建高性能的服务端、代理、抓包分析器与协议测试工具。 ## ✨ 特性 - 以 C++23 为核心实现 - 通过 `IPacket` 与数据包工厂统一管理 Bedrock 数据包 - 提供二进制序列化/反序列化基础能力： - `BinaryStream` - `ReadOnlyBinaryStream` - 支持 CMake 包导出与安装（`Protocol::Protocol`） - 使用 MPL-2.0 许可证 ## 🧩 环境要求 - CMake 3.20 或更高版本 - 支持 C++23 的编译器 ## 🛠️ 构建 ### 📄 配置 ```bash cmake -S . -B build -G Ninja ``` ### 📄 编译 ```bash cmake --build build ``` ### 📄 安装 ```bash cmake --install build ``` ## 🔌 在 CMake 项目中使用 安装后，可以这样在你的项目中引入： ```cmake find_package(Protocol CONFIG REQUIRED) target_link_libraries(your_target PRIVATE Protocol::Protocol) ``` ## 🚀 快速示例 ```cpp #include <sculk/protocol/MinecraftPackets.hpp> #include <sculk/protocol/packet/IPacket.hpp> #include <sculk/protocol/utility/BinaryStream.hpp> #include <sculk/protocol/utility/ReadOnlyBinaryStream.hpp> #include <cstddef> #include <vector> int main() { using namespace sculk::protocol; // 假设这里是来自网络层的原始数据。 std::vector<std::byte> input{}; ReadOnlyBinaryStream readStream{input}; const auto header = MinecraftPackets::readPacketHeader(readStream); auto packet = MinecraftPackets::createPacket(header); if (packet) { const auto readResult = packet->readNoHeader(readStream); if (!readResult) { return 1; } std::vector<std::byte> output; BinaryStream writeStream{output}; packet->writeWithHeader(writeStream); } return 0; } ``` ## 🗂️ 目录结构 - `include/sculk/protocol`：公开头文件 - `src/sculk/protocol`：实现代码 - `cmake`：CMake 包配置模板 - `scripts`：开发辅助脚本 ## 🧬 ABI 命名空间 公开 API 通过内联 ABI 命名空间进行版本化， 例如 `sculk::protocol::abi_v944`。 ## 🤝 欢迎贡献 欢迎任何形式的贡献。 - 你可以通过 Issue 提交 Bug、功能建议和协议讨论。 - 你可以通过 Pull Request 提交修复、优化与新数据包支持。 - 建议保持改动聚焦，并在描述中清晰说明行为变化。 ## ⚖️ 许可证 本项目采用 Mozilla Public License 2.0（MPL-2.0）开源。 完整许可证文本见 [LICENSE](LICENSE)。 MPL-2.0 核心要求（摘要）： - 若你修改了受 MPL 覆盖的文件并进行分发，这些被修改的文件需继续以 MPL-2.0 许可发布。 - 需保留受覆盖源码文件中的版权声明与许可证声明。 - 若你分发二进制或可执行形式，需要提供对应的受覆盖源码获取方式。 - 你可以在更大的工程中与其他许可代码组合使用，但受覆盖文件仍需满足 MPL 义务。 以上仅为便于理解的摘要，法律效力以 [LICENSE](LICENSE) 正文为准。 ### 版权所有 © 2026 SculkCatalystMC。保留所有权利。 [/MD]
鸣谢
本协议库由 Glacie 的协议库生成
github.com
开源地址
注意：
本项目不是任何加载器的插件，与 LeviLamina、Endstone 等没有任何关系！
本项目是一个静态库，是面向开发者的项目！
QQ交流群：1063182638
[MD] # 📄 Protocol    [📄 English README](README.md) 一个基于 C++23 的 Minecraft 基岩版网络协议库。 Protocol 提供基岩版数据包模型、数据包 ID 映射，以及二进制读写工具， 可用于构建高性能的服务端、代理、抓包分析器与协议测试工具。 ## ✨ 特性 - 以 C++23 为核心实现 - 通过 `IPacket` 与数据包工厂统一管理 Bedrock 数据包 - 提供二进制序列化/反序列化基础能力： - `BinaryStream` - `ReadOnlyBinaryStream` - 支持 CMake 包导出与安装（`Protocol::Protocol`） - 使用 MPL-2.0 许可证 ## 🧩 环境要求 - CMake 3.20 或更高版本 - 支持 C++23 的编译器 ## 🛠️ 构建 ### 📄 配置 ```bash cmake -S . -B build -G Ninja ``` ### 📄 编译 ```bash cmake --build build ``` ### 📄 安装 ```bash cmake --install build ``` ## 🔌 在 CMake 项目中使用 安装后，可以这样在你的项目中引入： ```cmake find_package(Protocol CONFIG REQUIRED) target_link_libraries(your_target PRIVATE Protocol::Protocol) ``` ## 🚀 快速示例 ```cpp #include <sculk/protocol/MinecraftPackets.hpp> #include <sculk/protocol/packet/IPacket.hpp> #include <sculk/protocol/utility/BinaryStream.hpp> #include <sculk/protocol/utility/ReadOnlyBinaryStream.hpp> #include <cstddef> #include <vector> int main() { using namespace sculk::protocol; // 假设这里是来自网络层的原始数据。 std::vector<std::byte> input{}; ReadOnlyBinaryStream readStream{input}; const auto header = MinecraftPackets::readPacketHeader(readStream); auto packet = MinecraftPackets::createPacket(header); if (packet) { const auto readResult = packet->readNoHeader(readStream); if (!readResult) { return 1; } std::vector<std::byte> output; BinaryStream writeStream{output}; packet->writeWithHeader(writeStream); } return 0; } ``` ## 🗂️ 目录结构 - `include/sculk/protocol`：公开头文件 - `src/sculk/protocol`：实现代码 - `cmake`：CMake 包配置模板 - `scripts`：开发辅助脚本 ## 🧬 ABI 命名空间 公开 API 通过内联 ABI 命名空间进行版本化， 例如 `sculk::protocol::abi_v944`。 ## 🤝 欢迎贡献 欢迎任何形式的贡献。 - 你可以通过 Issue 提交 Bug、功能建议和协议讨论。 - 你可以通过 Pull Request 提交修复、优化与新数据包支持。 - 建议保持改动聚焦，并在描述中清晰说明行为变化。 ## ⚖️ 许可证 本项目采用 Mozilla Public License 2.0（MPL-2.0）开源。 完整许可证文本见 [LICENSE](LICENSE)。 MPL-2.0 核心要求（摘要）： - 若你修改了受 MPL 覆盖的文件并进行分发，这些被修改的文件需继续以 MPL-2.0 许可发布。 - 需保留受覆盖源码文件中的版权声明与许可证声明。 - 若你分发二进制或可执行形式，需要提供对应的受覆盖源码获取方式。 - 你可以在更大的工程中与其他许可代码组合使用，但受覆盖文件仍需满足 MPL 义务。 以上仅为便于理解的摘要，法律效力以 [LICENSE](LICENSE) 正文为准。 ### 版权所有 © 2026 SculkCatalystMC。保留所有权利。 [/MD]
鸣谢
本协议库由 Glacie 的协议库生成
GitHub - GlacieTeam/ProtocolLib: A Multi-version Minecraft Bedrock Protocol Library Written in C++
A Multi-version Minecraft Bedrock Protocol Library Written in C++ - GlacieTeam/ProtocolLib
github.com
