2.1.10 โ€ข Published 9 months ago

@sanctumterra/client v2.1.10

Weekly downloads
-
License
ISC
Repository
-
Last release
9 months ago

๐Ÿ› ๏ธ Minecraft Bedrock Edition Client Library

Version npm License

A powerful and easy-to-use client library for Minecraft Bedrock Edition.

๐Ÿ“ฆ Installation

npm i @sanctumterra/client

โš ๏ธ Important Notes

  • The Connection class is a bare-bones client, while the Client class offers more features.
  • Due to protocol support requirements, versions cannot be automatically switched. Specific client library versions are needed.

๐Ÿ“Š Supported Versions

Client VersionProtocol VersionMinecraft Version
2.0.107121.21.20
2.1.57291.21.30

๐Ÿš€ Usage Example

const { Client, Logger, DeviceOS } = require("@sanctumterra/client");

const client = new Client({
    host: "127.0.0.1",
    port: 19132,
    offline: true,
    username: "SanctumTerra",
    tokensFolder: "./cache/tokens",
    version: "1.21.30",
    deviceOS: DeviceOS.Android
});

client.connect();

client.on("TextPacket", (packet) => {
    if (packet.parameters) {
        if (packet.message.includes("chat.type.text")) {
            return Logger.chat(`ยงf<${packet.parameters[0]}> ${packet.parameters[1]}`);
        }
        if (packet.message.includes("multiplayer.player.joined")) {
            return Logger.chat(`ยงe${packet.parameters[0]} joined the game`);
        }
        if (packet.message.includes("multiplayer.player.left")) {
            return Logger.chat(`ยงe${packet.parameters[0]} left the game`);
        }
        if (packet.message.includes("%chat.type.announcement")) {
            return Logger.chat(`ยงd<${packet.parameters[0]}> ${packet.parameters[1]}`);
        }
    }
    Logger.chat(packet.message);
});

client.on("spawn", () => {
    Logger.info("Spawned!");
});

๐Ÿ“š Features

๐ŸŽ›๏ธ Client Configuration

  • Required Parameters: host, port
  • Optional Parameters: offline, username, tokensFolder, version, deviceOS

๐Ÿ“ก Event Handling

  • 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.

๐ŸŽจ Custom Logging

  • Supports Minecraft color codes for in-game styled message logging
  • Easier to use and understand

๐Ÿ“œ Changelog

2.1.5

  • Added DeviceOS to the Client.

2.1.3

  • Removed Protocol Validation
  • Added more debug logs
  • Improved performance

2.1.2

  • Added a couple examples in /examples/ (readline, skinStealer).
  • debug logs n options.
  • Allow safe disconnection.

2.1.0

  • Separated Client into Connection and Client classes.
  • Fixed CraftingDataPacket for Shields.
  • Improved packet handling for pre-spawn packets.
  • Enhanced Listener Events for "secret" / "hidden" events.

2.0.11

  • Added support for Minecraft 1.21.30.

2.0.0

  • Initial Release of V2.

โค๏ธ Credits

ProjectDescriptionLink
SerenityJSPacket processing frameworksGitHub
PrismarineJSAuthentication frameworkGitHub
2.1.10

9 months ago

2.1.9

9 months ago

2.1.8

9 months ago

2.1.7

9 months ago

2.1.6

9 months ago

2.1.5

9 months ago

2.1.3

9 months ago

2.1.2

9 months ago

2.0.11

10 months ago

2.0.10

10 months ago

2.1.0

10 months ago

2.0.9

10 months ago

2.0.8

10 months ago

2.0.7

10 months ago

2.0.6

10 months ago

2.0.5

11 months ago

2.0.4

11 months ago

2.0.3

11 months ago

2.0.2

11 months ago

2.0.1

11 months ago

2.0.0

11 months ago

1.0.19

12 months ago

1.0.17

12 months ago

1.0.16

12 months ago

1.0.15

12 months ago

1.0.13

12 months ago

1.0.12

12 months ago

1.0.11

12 months ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago