Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PrismarineJS/bedrock-protocol
Minecraft Bedrock protocol library, with authentication and encryption
https://github.com/PrismarineJS/bedrock-protocol
bedrock bedrock-edition bedrock-protocol minecraft minecraft-pocket-edition raknet
Last synced: 3 months ago
JSON representation
Minecraft Bedrock protocol library, with authentication and encryption
- Host: GitHub
- URL: https://github.com/PrismarineJS/bedrock-protocol
- Owner: PrismarineJS
- License: mit
- Created: 2016-02-13T18:10:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T05:44:18.000Z (7 months ago)
- Last Synced: 2024-05-19T10:33:22.713Z (6 months ago)
- Topics: bedrock, bedrock-edition, bedrock-protocol, minecraft, minecraft-pocket-edition, raknet
- Language: JavaScript
- Homepage: https://prismarinejs.github.io/minecraft-data/?v=bedrock_1.17.10&d=protocol
- Size: 993 KB
- Stars: 269
- Watchers: 18
- Forks: 63
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-minecraft-bedrock - bedrock-protocol - Minecraft Bedrock protocol library, with authentication and encryption (Library)
README
# bedrock-protocol
[](http://npmjs.com/package/bedrock-protocol)
[](https://github.com/PrismarineJS/bedrock-protocol/actions?query=workflow%3A%22CI%22)
[](https://gitpod.io/#https://github.com/PrismarineJS/bedrock-protocol)
[](https://discord.gg/GsEFRM8)
Minecraft Bedrock Edition (aka MCPE) protocol library, supporting authentication and encryption. Help [contribute](docs/CONTRIBUTING.md).
[Protocol doc](https://prismarinejs.github.io/minecraft-data/?v=bedrock_1.19.10&d=protocol)
## Features
- Supports Minecraft Bedrock version 1.16.201, 1.16.210, 1.16.220, 1.17.0, 1.17.10, 1.17.30, 1.17.40, 1.18.0, 1.18.11, 1.18.30, 1.19.1, 1.19.10, 1.19.20, 1.19.21, 1.19.30, 1.19.40, 1.19.41, 1.19.50, 1.19.60, 1.19.62, 1.19.63, 1.19.70, 1.19.80, 1.20.0, 1.20.10, 1.20.30, 1.20.40, 1.20.50, 1.20.61, 1.20.71, 1.20.80, 1.21.0, 1.21.2
- Parse and serialize packets as JavaScript objects
- Automatically respond to keep-alive packets
- [Proxy and mitm connections](docs/API.md#proxy-docs)
- Client
- Authentication
- Encryption
- [Ping a server for status](docs/API.md#beping-host-port---serveradvertisement)
- Server
- Autheticate clients with Xbox Live
- Ping status
* Robust test coverage.
* Easily extend with many other PrismarineJS projects, world providers, and more
* Optimized for rapidly staying up to date with Minecraft protocol updates.
Want to contribute on something important for PrismarineJS ? go to https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects
## Installation
`npm install bedrock-protocol`
To update bedrock-protocol (or any Node.js package) and its dependencies after a previous install, you must run `npm update --depth 9999`
## Usage
### Client example
Example to connect to a server in offline mode, and relay chat messages back:
```js
const bedrock = require('bedrock-protocol')
const client = bedrock.createClient({
host: 'localhost', // optional
port: 19132, // optional, default 19132
username: 'Notch', // the username you want to join as, optional if online mode
offline: true // optional, default false. if true, do not login with Xbox Live. You will not be asked to sign-in if set to true.
})
client.on('text', (packet) => { // Listen for chat messages from the server and echo them back.
if (packet.source_name != client.username) {
client.queue('text', {
type: 'chat', needs_translation: false, source_name: client.username, xuid: '', platform_chat_id: '', filtered_message: '',
message: `${packet.source_name} said: ${packet.message} on ${new Date().toLocaleString()}`
})
}
})
```
### Client example joining a Realm
Example to connect to a Realm that the authenticating account is owner of or has been invited to:
```js
const bedrock = require('bedrock-protocol')
const client = bedrock.createClient({
realms: {
pickRealm: (realms) => realms[0] // Function which recieves an array of joined/owned Realms and must return a single Realm. Can be async
}
})
```
### Server example
*Can't connect locally on Windows? See the [faq](docs/FAQ.md)*
```js
const bedrock = require('bedrock-protocol')
const server = bedrock.createServer({
host: '0.0.0.0', // optional. host to bind as.
port: 19132, // optional
version: '1.17.10', // optional. The server version, latest if not specified.
})
server.on('connect', client => {
client.on('join', () => { // The client has joined the server.
const d = new Date() // Once client is in the server, send a colorful kick message
client.disconnect(`Good ${d.getHours() < 12 ? '§emorning§r' : '§3afternoon§r'} :)\n\nMy time is ${d.toLocaleString()} !`)
})
})
```
### Ping example
```js
const { ping } = require('bedrock-protocol')
ping({ host: 'play.cubecraft.net', port: 19132 }).then(res => {
console.log(res)
})
```
## Documentation
For documentation on the protocol, and packets/fields see the [protocol documentation](https://prismarinejs.github.io/minecraft-data/protocol).
* See [API documentation](docs/API.md)
* See [frequently asked questions and answers](docs/FAQ.md)
## Testing
```npm test```
## Debugging
You can enable some protocol debugging output using `DEBUG` environment variable.
Through node.js, add `process.env.DEBUG = 'minecraft-protocol'` at the top of your script.
## Contribute
Please read [CONTRIBUTING.md](docs/CONTRIBUTING.md) and https://github.com/PrismarineJS/prismarine-contribute
## History
See [history](HISTORY.md)