\n\nA powerful and easy-to-use client library for Minecraft Bedrock Edition.\n\n## ๐ฆ Installation\n\n```bash\nnpm i @sanctumterra/client\n```\n\n## โ ๏ธ Important Notes\n\n- The `Connection` class is a bare-bones client, while the `Client` class offers more features.\n- Due to protocol support requirements, versions cannot be automatically switched. Specific client library versions are needed.\n\n## ๐ Supported Versions\n\n| Client Version | Protocol Version | Minecraft Version |\n|----------------|-------------------|-------------------|\n| 2.0.10 | 712 | 1.21.20 |\n| 2.1.5 | 729 | 1.21.30 |\n| 2.1.12 | 748 | 1.21.40 |\n| 2.1.16 | 766 | 1.21.50 |\n\n## ๐ Usage Example\n\n```typescript\nconst { Client, Logger, DeviceOS } = require(\"@sanctumterra/client\");\n\nconst client = new Client({\n host: \"127.0.0.1\",\n port: 19132,\n offline: true,\n username: \"SanctumTerra\",\n tokensFolder: \"./cache/tokens\",\n version: \"1.21.50\",\n deviceOS: DeviceOS.Android,\n sendAuthInput: true,\n logPacketErrors: false,\n tickRate: 50 // 50 is the default tick rate\n});\n\nclient.connect();\n\nclient.on(\"TextPacket\", (packet) => {\n if (packet.parameters) {\n if (packet.message.includes(\"chat.type.text\")) {\n return Logger.chat(`ยงf<${packet.parameters[0]}> ${packet.parameters[1]}`);\n }\n if (packet.message.includes(\"multiplayer.player.joined\")) {\n return Logger.chat(`ยงe${packet.parameters[0]} joined the game`);\n }\n if (packet.message.includes(\"multiplayer.player.left\")) {\n return Logger.chat(`ยงe${packet.parameters[0]} left the game`);\n }\n if (packet.message.includes(\"%chat.type.announcement\")) {\n return Logger.chat(`ยงd<${packet.parameters[0]}> ${packet.parameters[1]}`);\n }\n }\n Logger.chat(packet.message);\n});\n\nclient.on(\"spawn\", () => {\n Logger.info(\"Spawned!\");\n});\n```\n\n## ๐ Features\n\n### ๐๏ธ Client Configuration\n- **Required Parameters**: `host`, `port`\n- **Optional Parameters**: \n`offline`, `username`, `tokensFolder`, `version`, `deviceOS`, `viewDistance`, `sendAuthInput`, `logPacketErrors`, `tickRate`\n\n### ๐ก Event Handling\n- Events allow you to listen to any implemented packet if it is not implemented you will receive a warning and it should not crash if there is a crash then make an issue on github.\n\n\n### ๐จ Custom Logging\n- Supports Minecraft color codes for in-game styled message logging\n- Easier to use and understand\n\n## ๐ Changelog\n\n### 2.1.16\n- Fixed bugs with BDS.\n- Added more options.\n- New Listener Events.\n\n### 2.1.14\n- Use latest version of Raknet\n- Fixes\n\n### 2.1.13\n- Added support for Minecraft 1.21.50.\n- Fixed many bugs.\n- Slightly Improved performance.\n\n### 2.1.12\n- Added support for Minecraft 1.21.40.\n- New Raknet! It now uses NAPI as Rust is faster.\n- connect function now returns [Advertisement, StartGamePacket]\n\n### 2.1.5\n- Added DeviceOS to the Client.\n\n### 2.1.3\n- Removed Protocol Validation\n- Added more debug logs\n- Improved performance\n\n### 2.1.2\n- Added a couple examples in /examples/ (readline, skinStealer).\n- debug logs n options.\n- Allow safe disconnection.\n\n### 2.1.0\n- Separated Client into Connection and Client classes.\n- Fixed CraftingDataPacket for Shields.\n- Improved packet handling for pre-spawn packets.\n- Enhanced Listener Events for \"secret\" / \"hidden\" events.\n\n### 2.0.11\n- Added support for Minecraft 1.21.30.\n\n### 2.0.0\n- Initial Release of V2.\n\n## โค๏ธ Credits\n\n| Project | Description | Link |\n|---------|-------------|------|\n| SerenityJS | Packet processing frameworks | [GitHub](https://github.com/SerenityJS/serenity) |\n| PrismarineJS | Authentication framework | [GitHub](https://github.com/PrismarineJS) |\n\n
![\"Discord\"](\"https://img.shields.io/static/v1.svg?label=Discord&message=Join&color=blue&logo=discord&style=for-the-badge\")
\n \n