diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index a71776b..0000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,3 +0,0 @@ -github: PrismarineJS -open_collective: prismarinejs -custom: https://rysolv.com/repos/detail/74691b23-938d-4b2f-b65a-5c47bf5b3f0f \ No newline at end of file diff --git a/.github/helper-bot/github-helper.js b/.github/helper-bot/github-helper.js new file mode 100644 index 0000000..08759b2 --- /dev/null +++ b/.github/helper-bot/github-helper.js @@ -0,0 +1,59 @@ +if (!process.env.CI) { + // mock a bunch of things for testing locally -- https://github.com/actions/toolkit/issues/71 + process.env.GITHUB_REPOSITORY = 'PrismarineJS/bedrock-protocol' + process.env.GITHUB_EVENT_NAME = 'issue_comment' + process.env.GITHUB_SHA = 'cb2fd97b6eae9f2c7fee79d5a86eb9c3b4ac80d8' + process.env.GITHUB_REF = 'refs/heads/master' + process.env.GITHUB_WORKFLOW = 'Issue comments' + process.env.GITHUB_ACTION = 'run1' + process.env.GITHUB_ACTOR = 'test-user' + module.exports = { getIssueStatus: () => ({}), updateIssue: () => {}, createIssue: () => {} } + return +} + +// const { Octokit } = require('@octokit/rest') // https://github.com/octokit/rest.js +const github = require('@actions/github') + +const token = process.env.GITHUB_TOKEN +const octokit = github.getOctokit(token) +const context = github.context + +async function getIssueStatus (title) { + // https://docs.github.com/en/rest/reference/search#search-issues-and-pull-requests + const existingIssues = await octokit.rest.search.issuesAndPullRequests({ + q: `is:issue repo:${process.env.GITHUB_REPOSITORY} in:title ${title}` + }) + // console.log('Existing issues', existingIssues) + const existingIssue = existingIssues.data.items.find(issue => issue.title === title) + + if (!existingIssue) return {} + + return { open: existingIssue.state === 'open', closed: existingIssue.state === 'closed', id: existingIssue.number } +} + +async function updateIssue (id, payload) { + const issue = await octokit.rest.issues.update({ + ...context.repo, + issue_number: id, + body: payload.body + }) + console.log(`Updated issue ${issue.data.title}#${issue.data.number}: ${issue.data.html_url}`) +} + +async function createIssue (payload) { + const issue = await octokit.rest.issues.create({ + ...context.repo, + ...payload + }) + console.log(`Created issue ${issue.data.title}#${issue.data.number}: ${issue.data.html_url}`) +} + +async function close (id, reason) { + if (reason) await octokit.rest.issues.createComment({ ...context.repo, issue_number: id, body: reason }) + const issue = await octokit.rest.issues.update({ ...context.repo, issue_number: id, state: 'closed' }) + console.log(`Closed issue ${issue.data.title}#${issue.data.number}: ${issue.data.html_url}`) +} + +if (process.env.CI) { + module.exports = { getIssueStatus, updateIssue, createIssue, close } +} diff --git a/.github/helper-bot/index.js b/.github/helper-bot/index.js index 8dffc6c..e9d5893 100644 --- a/.github/helper-bot/index.js +++ b/.github/helper-bot/index.js @@ -1,7 +1,7 @@ // Automatic version update checker for Minecraft bedrock edition. const fs = require('fs') const cp = require('child_process') -const helper = require('gh-helpers')() +const helper = require('./github-helper') const latestVesionEndpoint = 'https://itunes.apple.com/lookup?bundleId=com.mojang.minecraftpe&time=' + Date.now() const changelogURL = 'https://feedback.minecraft.net/hc/en-us/sections/360001186971-Release-Changelogs' @@ -102,10 +102,11 @@ async function fetchLatest () { console.log(version, currentVersionReleaseDate, releaseNotes) const title = `Support Minecraft ${result.version}` - const issueStatus = await helper.findIssue({ titleIncludes: title }) || {} + + const issueStatus = await helper.getIssueStatus(title) if (supportedVersions.includes(version)) { - if (issueStatus.isOpen) { + if (issueStatus.open) { helper.close(issueStatus.id, `Closing as ${version} is now supported`) } console.log('Latest version is supported.') @@ -113,7 +114,7 @@ async function fetchLatest () { } - if (issueStatus.isClosed) { + if (issueStatus.closed) { // We already made an issue, but someone else already closed it, don't do anything else console.log('I already made an issue, but it was closed') return @@ -126,7 +127,7 @@ async function fetchLatest () { CloudburstMC: getCommitsInRepo('CloudburstMC/Protocol', version, currentVersionReleaseDate) }) - if (issueStatus.isOpen) { + if (issueStatus.open) { helper.updateIssue(issueStatus.id, issuePayload) } else { helper.createIssue(issuePayload) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4176a31..bce70f7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,20 +17,14 @@ jobs: fail-fast: false matrix: os: [ubuntu-latest, windows-latest] - node-version: [22.x] + node-version: [16.x] runs-on: ${{ matrix.os }} - timeout-minutes: 14 + timeout-minutes: 12 steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - # Old versions of bedrock use old libssl that Ubuntu no longer ships with; need manual install - - name: (Linux) Install libssl 1.1 - if: runner.os == 'Linux' - run: | - wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb - sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2_amd64.deb - run: npm install - run: npm test diff --git a/.github/workflows/commands.yml b/.github/workflows/commands.yml deleted file mode 100644 index 111d139..0000000 --- a/.github/workflows/commands.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Repo Commands - -on: - issue_comment: # Handle comment commands - types: [created] - pull_request_target: # Handle renamed PRs - types: [edited] - -jobs: - comment-trigger: - runs-on: ubuntu-latest - steps: - - name: Check out repository - uses: actions/checkout@v3 - - name: Run command handlers - uses: PrismarineJS/prismarine-repo-actions@master - with: - # NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it. - token: ${{ secrets.PAT_PASSWORD }} - # See `Options` section below for more info on these options - install-command: npm install - /fixlint.fix-command: npm run fix diff --git a/.github/workflows/update-helper.yml b/.github/workflows/update-helper.yml index d9380da..83503ac 100644 --- a/.github/workflows/update-helper.yml +++ b/.github/workflows/update-helper.yml @@ -14,9 +14,9 @@ jobs: - name: Set up Node.js uses: actions/setup-node@master with: - node-version: 22.0.0 - - name: Install Github Actions helper - run: npm i gh-helpers + node-version: 16.0.0 + - name: Install Github Actions toolkit + run: npm i @actions/github # The env vars contain the relevant trigger information, so we don't need to pass it - name: Runs helper run: cd .github/helper-bot && node index.js diff --git a/.gitignore b/.gitignore index c14d132..bc2d2f9 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,4 @@ __* # Runtime generated data data/ tools/bds* -tools/pmmp* \ No newline at end of file +*.txt \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 93% rename from docs/CONTRIBUTING.md rename to CONTRIBUTING.md index 56d8f52..fd23544 100644 --- a/docs/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -110,39 +110,37 @@ The above roughly translates to the following JavaScript code to read a packet: ```js function read_position(stream) { const ret = {} - ret.x = stream.readLI32() - ret.z = stream.readLU32() - ret.y = stream.readLF32() + ret.x = stream.readSignedInt32LE() + ret.z = stream.readUnsignedInt32LE() + ret.y = stream.readFloat32LE() return ret } function read_player_position(stream) { const ret = {} ret.on_ground = Boolean(stream.readU8()) - ret.position = read_position(stream) + ret.position = read_player_position(stream) let __movement_reason = stream.readU8() let movement_reason = { 0: 'player_jump', 1: 'player_autojump', 2: 'player_sneak', 3: 'player_sprint', 4: 'player_fall' }[__movement_reason] switch (movement_reason) { case 'player_jump': case 'player_autojump': - ret.original_position = read_position(stream) - ret.jump_tick = stream.readLI64() + ret.original_position = read_player_position(stream) + ret.jump_tick = stream.readInt64LE(stream) break case 'player_fall': - ret.original_position = read_position(stream) + ret.original_position = read_player_position(stream) break default: break } ret.player_hunger = undefined if (movement_reason == 'player_sprint') ret.player_hunger = stream.readU8() ret.last_positions = [] - let __latest_positions_len = stream.readUnsignedVarInt() - for (let i = 0; i < __latest_positions_len; i++) { + for (let i = 0; i < stream.readUnsignedVarInt(); i++) { ret.last_positions.push(read_player_position(stream)) } ret.keys_down = [] - let __keys_down_len = stream.readZigZagVarInt() - for (let i = 0; i < __keys_down_len; i++) { + for (let i = 0; i < stream.readZigZagVarInt(); i++) { const ret1 = {} ret1.up = Boolean(stream.readU8()) ret1.down = Boolean(stream.readU8()) diff --git a/HISTORY.md b/HISTORY.md index 799d0a9..7604066 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,126 +1,8 @@ -## 3.49.0 -* [1.21.111 (#649)](https://github.com/PrismarineJS/bedrock-protocol/commit/b48518a6e79e72101fe7136433cbd6277339fc5c) (thanks @Slauh) -* [Skin Data Changes (#647)](https://github.com/PrismarineJS/bedrock-protocol/commit/407756b93880cdda4fdbff194fc4163ceedf4e82) (thanks @thejfkvis) - -## 3.48.1 -* [Update login client skinData (#635)](https://github.com/PrismarineJS/bedrock-protocol/commit/6b1474d2c6f93b47dee9d4816de59579f82ed5a9) (thanks @TSL534) - -## 3.48.0 -* [1.21.100 (#632)](https://github.com/PrismarineJS/bedrock-protocol/commit/06fb3de3a0023d03201dbcee7e9178c269462766) (thanks @extremeheat) - -## 3.47.0 -* [1.21.93 support (#623)](https://github.com/PrismarineJS/bedrock-protocol/commit/14daa2d95aac90ffcc7b42d625e270020ec2f162) (thanks @CreeperG16) - -## 3.46.0 -* [1.21.90 support (#617)](https://github.com/PrismarineJS/bedrock-protocol/commit/c66cdd3d62d2fa9c581693d8c70d7b41f355b63e) (thanks @CreeperG16) - -## 3.45.0 -* [1.21.80 (#602)](https://github.com/PrismarineJS/bedrock-protocol/commit/e71fd513ddbd432983f221980080b61e11576965) (thanks @extremeheat) - -## 3.44.0 -* [1.21.70 (#594)](https://github.com/PrismarineJS/bedrock-protocol/commit/065f41db8cfc8cbd8106bd9e376c899ec25f3f77) (thanks @CreeperG16) - -## 3.43.1 -* [Fix server not correctly removing clients (#588)](https://github.com/PrismarineJS/bedrock-protocol/commit/47f342ca958ba87a7719783bd5c855cebdd4aa65) (thanks @EntifiedOptics) - -## 3.43.0 -* [1.21.60 support (#570)](https://github.com/PrismarineJS/bedrock-protocol/commit/eeb5e47e35f31cc571a9a8a491f5a89b27e637f1) (thanks @CreeperG16) -* [Fix version feature handling (#572)](https://github.com/PrismarineJS/bedrock-protocol/commit/0ed8e32be85f05926cd97d5f0317ed004ae5eefa) (thanks @ItsMax123) - -## 3.42.3 -* [Fix Server `maxPlayers` option (#565)](https://github.com/PrismarineJS/bedrock-protocol/commit/38dc5a256105a44786d5455570d5a130e64ef561) (thanks @extremeheat) - -## 3.42.2 -* Fix missing type serialization error - -## 3.42.1 -* [Add 1.21.40 login fields (#553)](https://github.com/PrismarineJS/bedrock-protocol/commit/24d3200181c060162b04fb233fef6e0d6d1a93aa) (thanks @extremeheat) -* [Remove protodef varint types (#552)](https://github.com/PrismarineJS/bedrock-protocol/commit/347e303ce422bdb6f6dfd4cba57d7d3937214707) (thanks @extremeheat) - -## 3.42.0 -* [1.21.50 support](https://github.com/PrismarineJS/bedrock-protocol/commit/1c0836bff03d50cb12a3e45763eac6c9f605e00c) (thanks @extremeheat) -* [Dynamic compression & batch header (#544)](https://github.com/PrismarineJS/bedrock-protocol/commit/911e0e890febc00102cd1e5406731e66f7bad0ef) (thanks @LucienHH) - -## 3.41.0 -* [1.21.42 support](https://github.com/PrismarineJS/bedrock-protocol/commit/dd5c4de4f2624c3654af66e9a40a65eb13de0850) (thanks @CreeperG16) - -## 3.40.0 -* [1.21.30 support (#527)](https://github.com/PrismarineJS/bedrock-protocol/commit/fc30c96135ec20dca1257f702152cba61d4a59be) (thanks @pokecosimo) -* [Update tests (#528)](https://github.com/PrismarineJS/bedrock-protocol/commit/cb530c8b45bf505f75e0e39241d88085c5564ae8) (thanks @extremeheat) - -## 3.39.0 -* [1.21.20](https://github.com/PrismarineJS/bedrock-protocol/commit/3be55777fab4949179d3a7108ee29bbd8fada5a7) (thanks @extremeheat) -* [update disconnect packet](https://github.com/PrismarineJS/bedrock-protocol/commit/4c3f62567e0f6ce20b70ea23238fce8606011e95) (thanks @extremeheat) - -## 3.38.0 -* [Support 1.21.2, and add missing versions to type definitions (#510)](https://github.com/PrismarineJS/bedrock-protocol/commit/5d3986924d3f262708d7c7e55a7f410f12c7903c) (thanks @CreeperG16) -* [Fix example in README.md for 1.21 (#506)](https://github.com/PrismarineJS/bedrock-protocol/commit/c4593aa355d6ce9e2ac65cc2102cd9285a6b6449) (thanks @Ant767) -* [Don't send now deprecated tick sync packets on 1.21 and newer (#504)](https://github.com/PrismarineJS/bedrock-protocol/commit/84c5231b92df9f5f1a09b29a05e7abfed62f1c2b) (thanks @w0ahL) - -## 3.37.0 -* [Support 1.21.0](https://github.com/PrismarineJS/bedrock-protocol/commit/5b2d78792c9b4c070d727a9028a6b3a266483e1c) (thanks @CreeperG16) -* [Fix typo in types (#501)](https://github.com/PrismarineJS/bedrock-protocol/commit/16e15d80a5084a19ed2fbabc023789ee38922b3a) (thanks @Kaaaaii) - -## 3.36.0 -* [Support 1.20.80](https://github.com/PrismarineJS/bedrock-protocol/commit/bd32aa8d04555fa2fdc4ecd6abbeb6124e2ae8bb) (thanks @extremeheat) - -## 3.35.0 -* [Support 1.20.71](https://github.com/PrismarineJS/bedrock-protocol/commit/d8e707112acc038b6c9564d9a21b2f977326e47f) (thanks @extremeheat) -* [Note `npm update` command in readme](https://github.com/PrismarineJS/bedrock-protocol/commit/ab93d0d0824bd0ace250fb73f703dc7b60ecd780) (thanks @extremeheat) - -## 3.34.0 -* [1.20.61 support (#480)](https://github.com/PrismarineJS/bedrock-protocol/commit/c278a03f952d23320b80f8c09b6372d41eeff26a) (thanks @extremeheat) -* [Compressor handling update for 1.20.60 (#479)](https://github.com/PrismarineJS/bedrock-protocol/commit/d3161badc65f2eba4b6e7c9e974ca4e3529a7e94) (thanks @extremeheat) -* [Update and rename CONTRIBUTING.md to docs/CONTRIBUTING.md (#475)](https://github.com/PrismarineJS/bedrock-protocol/commit/be6f0cde9f7970a4f9aa376c589c58d8cb4187c3) (thanks @extremeheat) -* [Add flow and deviceType options to relay (#464)](https://github.com/PrismarineJS/bedrock-protocol/commit/842e66266f09e8670a644a618d0ac4157746cd43) (thanks @GameParrot) - -## 3.33.1 -* [Fix zigzag type move in prismarine-nbt (#471)](https://github.com/PrismarineJS/bedrock-protocol/commit/7b74cbf7129646adc80d50304afce6240848cfae) (thanks @extremeheat) - -## 3.33.0 -* [1.20.50 (#466)](https://github.com/PrismarineJS/bedrock-protocol/commit/d53211c6a1fe5f941ce547886ad6ec031ae05d9d) (thanks @extremeheat) -* [Add 1.20.30 and 1.20.40 to index.d.ts (#461)](https://github.com/PrismarineJS/bedrock-protocol/commit/2ecf01d63e64b910b87f303fc4fb2b30f392cb28) (thanks @CreeperG16) - -## 3.32.0 -* [1.20.40 support (#459)](https://github.com/PrismarineJS/bedrock-protocol/commit/63eb673c1f30beb58f97e3b37295129000bf6a10) (thanks @CreeperG16) -* [Update Minecraft wiki link to new domain (#455)](https://github.com/PrismarineJS/bedrock-protocol/commit/689658c4ab1ccb3ef1ae812d78d090212b1acf3f) (thanks @Spongecade) - -## 3.31.0 -* [1.20.30](https://github.com/PrismarineJS/bedrock-protocol/commit/22502b90fdc29f6327239c6c201370c8f839c892) (thanks @extremeheat) -* [Add links field to server resource_packs_info](https://github.com/PrismarineJS/bedrock-protocol/commit/f92db61c89851dfbdbc906f926fc1433162854d0) (thanks @extremeheat) -* [Update API.md (#448)](https://github.com/PrismarineJS/bedrock-protocol/commit/8f3b6c5aecf24d6f8d235afe2a9d911840e6a3f8) (thanks @Laamy) - -## 3.30.1 -* [Update Mojang public key used for logins (#443)](https://github.com/PrismarineJS/bedrock-protocol/commit/f0f1351d40966192e38ee9fe21b7c37754abba04) (thanks @GameParrot) -* [index.d.ts: Fixed a typo (#441)](https://github.com/PrismarineJS/bedrock-protocol/commit/2c00402a9e9a0a283e712bf4f52190a57ea12c3f) (thanks @kotinash) -* [Mark `listen` and `close` as async (#440)](https://github.com/PrismarineJS/bedrock-protocol/commit/50cd489f6e16fa6fe04b1825617d8246bd3935f4) (thanks @MrSterdy) -* [Stop disconnecting when upstream packet deserialization fails (#435)](https://github.com/PrismarineJS/bedrock-protocol/commit/141442057464b3247ace8468863f27a3c334306e) (thanks @MrSterdy) -* [Add 1.20.0 and 1.20.10 to index.d.ts (#431)](https://github.com/PrismarineJS/bedrock-protocol/commit/010d57e78a9130c612e48db7a32f841de83e9c68) (thanks @CreeperG16) - -## 3.30.0 -* 1.20.10 support (thanks @CreeperG16) -* [Fix upstream relay batchingInterval (#425)](https://github.com/PrismarineJS/bedrock-protocol/commit/b2c141c25f3fad9641644742b6cc1a71bc601d61) (thanks @GameParrot) - -## 3.29.1 -* Add missing data to client login user chain (#420) -* Add FAQ entry and replit warning on client ping error (#415) -* Types: Fix Relay authTitle type (#418) - -## 3.29.0 -* 1.20.0 support - -## 3.28.1 -* Fix `followPort` option (@LucienHH) -* Typescript definition fixes (@hvlxh) - -## 3.28.0 -* 1.19.80 support - ## 3.27.1 * Fix `raknetBackend` option not being applied correctly ## 3.27.0 -* Corrections to types (@stevarino) +* Corrections to types * Expose ServerAdvertisement class (#368) @hvlxh * Update mc-data links diff --git a/README.md b/README.md index 5e3add2..c2ebcb9 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ [![Official Discord](https://img.shields.io/static/v1.svg?label=OFFICIAL&message=DISCORD&color=blue&logo=discord&style=for-the-badge)](https://discord.gg/GsEFRM8) -Minecraft Bedrock Edition (aka MCPE) protocol library, supporting authentication and encryption. Help [contribute](docs/CONTRIBUTING.md). +Minecraft Bedrock Edition (aka MCPE) protocol library, supporting authentication and encryption. Help [contribute](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, 1.21.21, 1.21.30, 1.21.42, 1.21.50, 1.21.60, 1.21.70, 1.21.80, 1.21.90, 1.21.93, 1.21.100, 1.21.111 + - 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 - Parse and serialize packets as JavaScript objects - Automatically respond to keep-alive packets - [Proxy and mitm connections](docs/API.md#proxy-docs) @@ -34,8 +34,6 @@ Want to contribute on something important for PrismarineJS ? go to https://githu `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 @@ -54,7 +52,7 @@ const client = bedrock.createClient({ 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: '', + type: 'chat', needs_translation: false, source_name: client.username, xuid: '', platform_chat_id: '', message: `${packet.source_name} said: ${packet.message} on ${new Date().toLocaleString()}` }) } @@ -128,7 +126,7 @@ Through node.js, add `process.env.DEBUG = 'minecraft-protocol'` at the top of yo ## Contribute -Please read [CONTRIBUTING.md](docs/CONTRIBUTING.md) and https://github.com/PrismarineJS/prismarine-contribute +Please read [CONTRIBUTING.md](CONTRIBUTING.md) and https://github.com/PrismarineJS/prismarine-contribute ## History diff --git a/docs/API.md b/docs/API.md index d69c385..f98fa77 100644 --- a/docs/API.md +++ b/docs/API.md @@ -142,7 +142,7 @@ client.on('text', (packet) => { // names and as explained in the "Protocol doc" section below, fields are all case sensitive! client.on('add_player', (packet) => { client.queue('text', { - type: 'chat', needs_translation: false, source_name: client.username, xuid: '', platform_chat_id: '', filtered_message: '', + type: 'chat', needs_translation: false, source_name: client.username, xuid: '', platform_chat_id: '', message: `Hey, ${packet.username} just joined!` }) }) @@ -206,22 +206,16 @@ relay.on('connect', player => { console.log('New connection', player.connection.address) // Server is sending a message to the client. - player.on('clientbound', ({ name, params }, des) => { + player.on('clientbound', ({ name, params }) => { if (name === 'disconnect') { // Intercept kick params.message = 'Intercepted' // Change kick message to "Intercepted" } }) // Client is sending a message to the server - player.on('serverbound', ({ name, params }, des) => { + player.on('serverbound', ({ name, params }) => { if (name === 'text') { // Intercept chat message to server and append time. params.message += `, on ${new Date().toLocaleString()}` } - - if (name === 'command_request') { // Intercept command request to server and cancel if its "/test" - if (params.command == "/test") { - des.canceled = true - } - } }) }) ``` diff --git a/docs/FAQ.md b/docs/FAQ.md index f0eb1e1..852d884 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -20,23 +20,6 @@ Get-AppxPackage -AllUsers | Where Name -Match ".*Minecraft.*" | Select Name,Inst Use the PackageFullName field in place of the `Microsoft.MinecraftUWP_8wekyb3d8bbwe` for the command above. -## Replit - -Replit may [not support](https://github.com/PrismarineJS/bedrock-protocol/issues/363) the necessary outbound UDP connections required to connect to a Minecraft server. For further assistance using Replit, please contact Replit support or consider using an alternative hosting service if hosting locally is not possible. - -Some alternatives: -* [Gitpod](https://www.gitpod.io/) - * Gitpod is a cloud development environment for teams to efficiently and securely develop software, right from your browser. -* [Github Codespaces](https://github.com/features/codespaces) - * A Codespace is a developer environment like Gitpod that's hosted in the cloud, accessed in your browser. -* [Google Colab](https://colab.research.google.com/) - * Google Colab is a Jupyter notebook environment. Jupyter notebook offer a Python environment where you can write, explain, visualize and execute code straight from a web-based developer environment. For more information on using Colab for JavaScript projects, see [Mineflayer on Google Colab](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb). - ## Kicked during login -NOTE: If you not receiving any errors, the error probably logged in debug mode which is not enabled. To enable it, set `process.env.DEBUG = 'minecraft-protocol'` to the top of the file Some servers can kick you if you don't set `authTitle` as explained in the README. - -## Server clients kicked due to "jwt not active" - -The system time is incorrect and needs to be corrected. diff --git a/examples/client/client.js b/examples/client/client.js index 9f17e57..7bbd028 100644 --- a/examples/client/client.js +++ b/examples/client/client.js @@ -10,7 +10,7 @@ const client = bedrock.createClient({ client.on('text', (packet) => { // Listen for chat messages 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: '', + type: 'chat', needs_translation: false, source_name: client.username, xuid: '', platform_chat_id: '', message: `${packet.source_name} said: ${packet.message} on ${new Date().toLocaleString()}` }) } diff --git a/examples/server/basicServer.js b/examples/server/basicServer.js index 4febee6..92039f7 100644 --- a/examples/server/basicServer.js +++ b/examples/server/basicServer.js @@ -3,7 +3,7 @@ const bedrock = require('bedrock-protocol') const server = bedrock.createServer({ host: '0.0.0.0', // optional port: 19132, // optional - version: '1.19.80', // The server version + version: '1.17.10', // The server version motd: { // The message of the day motd: 'Funtime Server', levelName: 'Wonderland' @@ -12,7 +12,7 @@ const server = bedrock.createServer({ server.on('connect', client => { client.on('join', () => { // The client has joined the server. - const date = new Date() // Once client is in the server, send a colorful kick message - client.disconnect(`Good ${date.getHours() < 12 ? '§emorning§r' : '§3afternoon§r'}\n\nMy time is ${date.toLocaleString()} !`) + 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()} !`) }) }) diff --git a/examples/server/server.js b/examples/server/server.js index 555f83d..7d247a0 100644 --- a/examples/server/server.js +++ b/examples/server/server.js @@ -53,8 +53,7 @@ async function startServer (version = '1.17.10', ok) { must_accept: false, has_scripts: false, behaviour_packs: [], - texture_packs: [], - resource_pack_links: [] + texture_packs: [] }) // ResourcePackStack is sent by the server to send the order in which resource packs and behaviour packs diff --git a/index.d.ts b/index.d.ts index 3f4a571..694aa2f 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,21 +1,23 @@ -import EventEmitter from 'events' -import { Realm } from 'prismarine-realms' -import { ServerDeviceCodeResponse } from 'prismarine-auth' +import EventEmitter from "events" +import { Realm } from "prismarine-realms" +import { ServerDeviceCodeResponse } from "prismarine-auth" -declare module 'bedrock-protocol' { - type Version = '1.21.93' | '1.21.90' | '1.21.80' | '1.21.70' | '1.21.60' | '1.21.50' | '1.21.42' | '1.21.30' | '1.21.2' | '1.21.0' | '1.20.80' | '1.20.71' | '1.20.61' | '1.20.50' | '1.20.40' | '1.20.30' | '1.20.10' | '1.20.0' | '1.19.80' | '1.19.70' | '1.19.63' | '1.19.62' | '1.19.60' | '1.19.51' | '1.19.50' | '1.19.41' | '1.19.40' | '1.19.31' | '1.19.30' | '1.19.22' | '1.19.21' | '1.19.20' | '1.19.11' | '1.19.10' | '1.19.2' | '1.19.1' | '1.18.31' | '1.18.30' | '1.18.12' | '1.18.11' | '1.18.10' | '1.18.2' | '1.18.1' | '1.18.0' | '1.17.41' | '1.17.40' | '1.17.34' | '1.17.30' | '1.17.11' | '1.17.10' | '1.17.0' | '1.16.220' | '1.16.210' | '1.16.201' +declare module "bedrock-protocol" { + type Version = '1.19.70' | '1.19.63' | '1.19.62' | '1.19.60' | '1.19.51' | '1.19.50' | '1.19.41 | 1.19.40' | '1.19.31' | '1.19.30' | '1.19.22' | '1.19.21' | '1.19.20' | '1.19.11' | '1.19.10' | '1.19.2' | '1.19.1' | '1.18.31' | '1.18.30' | '1.18.12' | '1.18.11' | '1.18.10' | '1.18.2' | '1.18.1' | '1.18.0' | '1.17.41' | '1.17.40' | '1.17.34' | '1.17.30' | '1.17.11' | '1.17.10' | '1.17.0' | '1.16.220' | '1.16.210' | '1.16.201' + + enum title { MinecraftNintendoSwitch, MinecraftJava } export interface Options { // The string version to start the client or server as - version?: Version + version?: string // For the client, the host of the server to connect to (default: 127.0.0.1) // For the server, the host to bind to (default: 0.0.0.0) host: string // The port to connect or bind to, default: 19132 - port: number + port?: number // For the client, if we should login with Microsoft/Xbox Live. // For the server, if we should verify client's authentication with Xbox Live. - offline?: boolean + offline?: boolean, // Which raknet backend to use raknetBackend?: 'jsp-raknet' | 'raknet-native' | 'raknet-node' @@ -29,11 +31,11 @@ declare module 'bedrock-protocol' { export interface ClientOptions extends Options { // The username to connect to the server as - username: string + username: string, // The view distance in chunks - viewDistance?: number + viewDistance?: number, // Specifies which game edition to sign in as. Optional, but some servers verify this. - authTitle?: string + authTitle?: title | string, // How long to wait in milliseconds while trying to connect to the server. connectTimeout?: number // whether to skip initial ping and immediately connect @@ -47,35 +49,31 @@ declare module 'bedrock-protocol' { // the path to store authentication caches, defaults to .minecraft profilesFolder?: string | false // Called when microsoft authorization is needed when not provided it will the information log to the console instead - onMsaCode?: (data: ServerDeviceCodeResponse) => void + onMsaCode?: (data: ServerDeviceCodeResponse) => void; } export interface ServerOptions extends Options { // The maximum number of players allowed on the server at any time. - maxPlayers?: number - motd?: { + maxPlayers: number + motd: { // The header for the MOTD shown in the server list. - motd: string + motd: string, // The sub-header for the MOTD shown in the server list. - levelName?: string + levelName: string } - advertisementFn?: () => ServerAdvertisement + advertisementFn: () => ServerAdvertisement } enum ClientStatus { - Disconnected, - Authenticating, - Initializing, - Initialized + Disconected, Authenticating, Initializing, Initialized } export class Connection extends EventEmitter { - readonly status: ClientStatus + readonly status: ClientStatus; // Check if the passed version is less than or greater than the current connected client version. versionLessThan(version: string | number): boolean versionGreaterThan(version: string | number): boolean - versionGreaterThanOrEqualTo(version: string | number): boolean // Writes a Minecraft bedrock packet and sends it without queue batching write(name: string, params: object): void @@ -102,6 +100,7 @@ declare module 'bedrock-protocol' { // # Displays "Wow this server is popular! Check back later to see if space opens up. Server Full" | 'failed_server_full' + export class Client extends Connection { constructor(options: Options) // The client's EntityID returned by the server @@ -110,7 +109,7 @@ declare module 'bedrock-protocol' { /** * Close the connection, leave the server. */ - close(reason?: string): void + close(): void /** * Send a disconnect packet and close the connection @@ -122,15 +121,6 @@ declare module 'bedrock-protocol' { * `Player` represents a player connected to the server. */ export class Player extends Connection { - profile?: { - xuid: string - uuid: string - name: string - } - version: string - - getUserData(): object - /** * Disconnects a client before it has logged in via a PlayStatus packet. * @param {string} playStatus @@ -152,53 +142,43 @@ declare module 'bedrock-protocol' { on(event: 'login', cb: () => void): any on(event: 'join', cb: () => void): any on(event: 'close', cb: (reason: string) => void): any - on(event: 'packet', cb: (packet: object) => void): any - on(event: 'spawn', cb: (reason: string) => void): any } export class Server extends EventEmitter { clients: Map + // Connection logging function conLog: Function - constructor(options: Options) - - listen(): Promise - close(disconnectReason?: string): Promise - - on(event: 'connect', cb: (client: Player) => void): any + listen(host?: string, port?: number): void + // Disconnects all currently connected clients + close(disconnectReason: string): void } type RelayOptions = Options & { // Toggle packet logging. - logging?: boolean + logging?: boolean, // Skip authentication for connecting clients? - offline?: false + offline?: false, // Specifies which game edition to sign in as to the destination server. Optional, but some servers verify this. - authTitle?: string + authTitle?: title | string // Where to proxy requests to. destination: { realms?: RealmsOptions - host: string - port: number + host: string, + port: number, // Skip authentication connecting to the remote server? - offline?: boolean + offline?: boolean, } // Whether to enable chunk caching (default: false) enableChunkCaching?: boolean // Only allow one client to connect at a time (default: false) - forceSingle?: boolean - - // Do not disconnect clients on server packet parsing errors and drop the packet instead (default: false) - omitParseErrors?: boolean + forceSinge?: boolean // Dispatched when a new client has logged in, and we need authentication // tokens to join the backend server. Cached after the first login. // If this is not specified, the client will be disconnected with a login prompt. onMsaCode?(data: ServerDeviceCodeResponse, client: Client): any - // prismarine-auth configuration - flow?: string, - deviceType?: string } export class Relay extends Server { @@ -212,13 +192,9 @@ declare module 'bedrock-protocol' { version: string playersOnline: number playersMax: number + gamemode: string serverId: string - levelName: string - gamemodeId: number - portV4: number - portV6: number - - constructor(obj: object, port: number, version: string) + levelName:string } export interface RealmsOptions { @@ -230,11 +206,5 @@ declare module 'bedrock-protocol' { export function createClient(options: ClientOptions): Client export function createServer(options: ServerOptions): Server - export function ping({ - host, - port - }: { - host: string - port: number - }): Promise + export function ping({ host, port }: { host: string, port: number }): Promise } diff --git a/package.json b/package.json index 6301be0..5689f2d 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,14 @@ { "name": "bedrock-protocol", - "version": "3.49.0", + "version": "3.27.1", "description": "Minecraft Bedrock Edition protocol library", "main": "index.js", - "types": "index.d.ts", "scripts": { "build": "cd tools && node compileProtocol.js", - "test": "mocha --retries 2 --bail --exit", + "test": "mocha --bail --exit", "pretest": "npm run lint", "lint": "standard", - "vanillaServer": "minecraft-bedrock-server --root tools --version", + "vanillaServer": "node tools/startVanillaServer.js", "dumpPackets": "node tools/genPacketDumps.js", "fix": "standard --fix" }, @@ -40,8 +39,7 @@ "bedrock-protocol": "file:.", "bedrock-provider": "^2.0.0", "leveldb-zlib": "^1.0.1", - "minecraft-bedrock-server": "^1.4.2", - "mocha": "^11.0.1", + "mocha": "^10.0.0", "protodef-yaml": "^1.1.0", "standard": "^17.0.0-2" }, diff --git a/src/client.js b/src/client.js index e3af1d0..b6bb0ac 100644 --- a/src/client.js +++ b/src/client.js @@ -26,7 +26,6 @@ class Client extends Connection { this.compressionAlgorithm = this.versionGreaterThanOrEqualTo('1.19.30') ? 'none' : 'deflate' this.compressionThreshold = 512 this.compressionLevel = this.options.compressionLevel - this.batchHeader = 0xfe if (isDebug) { this.inLog = (...args) => debug('C ->', ...args) @@ -43,7 +42,6 @@ class Client extends Connection { this.validateOptions() this.serializer = createSerializer(this.options.version) this.deserializer = createDeserializer(this.options.version) - this._loadFeatures() KeyExchange(this, null, this.options) Login(this, null, this.options) @@ -57,19 +55,6 @@ class Client extends Connection { this.emit('connect_allowed') } - _loadFeatures () { - try { - const mcData = require('minecraft-data')('bedrock_' + this.options.version) - this.features = { - compressorInHeader: mcData.supportFeature('compressorInPacketHeader'), - itemRegistryPacket: mcData.supportFeature('itemRegistryPacket'), - newLoginIdentityFields: mcData.supportFeature('newLoginIdentityFields') - } - } catch (e) { - throw new Error(`Unsupported version: '${this.options.version}', no data available`) - } - } - connect () { if (!this.connection) throw new Error('Connect not currently allowed') // must wait for `connect_allowed`, or use `createClient` this.on('session', this._connect) @@ -135,7 +120,6 @@ class Client extends Connection { updateCompressorSettings (packet) { this.compressionAlgorithm = packet.compression_algorithm || 'deflate' this.compressionThreshold = packet.compression_threshold - this.compressionReady = true } sendLogin () { @@ -147,18 +131,9 @@ class Client extends Connection { ...this.accessToken // Mojang + Xbox JWT from auth ] - let encodedChain - if (this.features.newLoginIdentityFields) { // 1.21.90+ - encodedChain = JSON.stringify({ - Certificate: JSON.stringify({ chain }), - // 0 = normal, 1 = ss, 2 = offline - AuthenticationType: this.options.offline ? 2 : 0, - Token: '' - }) - } else { - encodedChain = JSON.stringify({ chain }) - } - debug('Auth chain', encodedChain) + const encodedChain = JSON.stringify({ chain }) + + debug('Auth chain', chain) this.write('login', { protocol_version: this.options.protocolVersion, @@ -195,8 +170,7 @@ class Client extends Connection { if (this.status === ClientStatus.Disconnected) return this.write('disconnect', { hide_disconnect_screen: hide, - message: reason, - filtered_message: '' + message: reason }) this.close(reason) } @@ -252,9 +226,7 @@ class Client extends Connection { break case 'start_game': this.startGameData = pakData.params - // fallsthrough - case 'item_registry': // 1.21.60+ send itemstates in item_registry packet - pakData.params.itemstates?.forEach(state => { + this.startGameData.itemstates.forEach(state => { if (state.name === 'minecraft:shield') { this.serializer.proto.setVariable('ShieldItemID', state.runtime_id) this.deserializer.proto.setVariable('ShieldItemID', state.runtime_id) diff --git a/src/connection.js b/src/connection.js index f1e9051..bc1d56b 100644 --- a/src/connection.js +++ b/src/connection.js @@ -28,25 +28,17 @@ class Connection extends EventEmitter { } versionLessThan (version) { - if (typeof version === 'string' && !Versions[version]) throw Error('Unknown version: ' + version) return this.options.protocolVersion < (typeof version === 'string' ? Versions[version] : version) } versionGreaterThan (version) { - if (typeof version === 'string' && !Versions[version]) throw Error('Unknown version: ' + version) return this.options.protocolVersion > (typeof version === 'string' ? Versions[version] : version) } versionGreaterThanOrEqualTo (version) { - if (typeof version === 'string' && !Versions[version]) throw Error('Unknown version: ' + version) return this.options.protocolVersion >= (typeof version === 'string' ? Versions[version] : version) } - versionLessThanOrEqualTo (version) { - if (typeof version === 'string' && !Versions[version]) throw Error('Unknown version: ' + version) - return this.options.protocolVersion <= (typeof version === 'string' ? Versions[version] : version) - } - startEncryption (iv) { this.encryptionEnabled = true this.inLog?.('Started encryption', this.sharedSecret, iv) @@ -70,18 +62,10 @@ class Connection extends EventEmitter { } } - _processOutbound (name, params) { - if (name === 'item_registry') { - this.updateItemPalette(params.itemstates) - } else if (name === 'start_game' && params.itemstates) { - this.updateItemPalette(params.itemstates) - } - } - write (name, params) { this.outLog?.(name, params) - this._processOutbound(name, params) - const batch = new Framer(this) + if (name === 'start_game') this.updateItemPalette(params.itemstates) + const batch = new Framer(this.compressionAlgorithm, this.compressionLevel, this.compressionThreshold) const packet = this.serializer.createPacketBuffer({ name, params }) batch.addEncodedPacket(packet) @@ -94,7 +78,7 @@ class Connection extends EventEmitter { queue (name, params) { this.outLog?.('Q <- ', name, params) - this._processOutbound(name, params) + if (name === 'start_game') this.updateItemPalette(params.itemstates) const packet = this.serializer.createPacketBuffer({ name, params }) if (name === 'level_chunk') { // Skip queue, send ASAP @@ -107,7 +91,7 @@ class Connection extends EventEmitter { _tick () { if (this.sendQ.length) { - const batch = new Framer(this) + const batch = new Framer(this.compressionAlgorithm, this.compressionLevel, this.compressionThreshold) batch.addEncodedPackets(this.sendQ) this.sendQ = [] this.sendIds = [] @@ -131,7 +115,7 @@ class Connection extends EventEmitter { */ sendBuffer (buffer, immediate = false) { if (immediate) { - const batch = new Framer(this) + const batch = new Framer(this.compressionAlgorithm, this.compressionLevel, this.compressionThreshold) batch.addEncodedPacket(buffer) if (this.encryptionEnabled) { this.sendEncryptedBatch(batch) @@ -165,29 +149,29 @@ class Connection extends EventEmitter { // These are callbacks called from encryption.js onEncryptedPacket = (buf) => { - const packet = this.batchHeader ? Buffer.concat([Buffer.from([this.batchHeader]), buf]) : buf + const packet = Buffer.concat([Buffer.from([0xfe]), buf]) // add header + this.sendMCPE(packet) } onDecryptedPacket = (buf) => { const packets = Framer.getPackets(buf) + for (const packet of packets) { this.readPacket(packet) } } handle (buffer) { // handle encapsulated - if (!this.batchHeader || buffer[0] === this.batchHeader) { // wrapper + if (buffer[0] === 0xfe) { // wrapper if (this.encryptionEnabled) { this.decrypt(buffer.slice(1)) } else { - const packets = Framer.decode(this, buffer) + const packets = Framer.decode(this.compressionAlgorithm, buffer) for (const packet of packets) { this.readPacket(packet) } } - } else { - throw Error('Bad packet header ' + buffer[0]) } } } diff --git a/src/createClient.js b/src/createClient.js index 9d14134..17b9d31 100644 --- a/src/createClient.js +++ b/src/createClient.js @@ -20,8 +20,8 @@ function createClient (options) { const adVersion = ad.version?.split('.').slice(0, 3).join('.') // Only 3 version units client.options.version = options.version ?? (Options.Versions[adVersion] ? adVersion : Options.CURRENT_VERSION) - if (ad.portV4 && client.options.followPort) { - client.options.port = ad.portV4 + if (ad.port && options.followPort) { + client.options.port = ad.port } client.conLog?.(`Connecting to ${client.options.host}:${client.options.port} ${ad.motd} (${ad.levelName}), version ${ad.version} ${client.options.version !== ad.version ? ` (as ${client.options.version})` : ''}`) @@ -56,41 +56,35 @@ function connect (client) { }) client.queue('client_cache_status', { enabled: false }) - - if (client.versionLessThanOrEqualTo('1.20.80')) client.queue('tick_sync', { request_time: BigInt(Date.now()), response_time: 0n }) - + client.queue('tick_sync', { request_time: BigInt(Date.now()), response_time: 0n }) sleep(500).then(() => client.queue('request_chunk_radius', { chunk_radius: client.viewDistance || 10 })) }) - if (client.versionLessThanOrEqualTo('1.20.80')) { - const keepAliveInterval = 10 - const keepAliveIntervalBig = BigInt(keepAliveInterval) + // Send tick sync packets every 10 ticks + const keepAliveInterval = 10 + const keepAliveIntervalBig = BigInt(keepAliveInterval) + let keepalive + client.tick = 0n + client.once('spawn', () => { + keepalive = setInterval(() => { + // Client fills out the request_time and the server does response_time in its reply. + client.queue('tick_sync', { request_time: client.tick, response_time: 0n }) + client.tick += keepAliveIntervalBig + }, 50 * keepAliveInterval) - let keepalive - client.tick = 0n - - client.once('spawn', () => { - keepalive = setInterval(() => { - // Client fills out the request_time and the server does response_time in its reply. - client.queue('tick_sync', { request_time: client.tick, response_time: 0n }) - client.tick += keepAliveIntervalBig - }, 50 * keepAliveInterval) - - client.on('tick_sync', async packet => { - client.emit('heartbeat', packet.response_time) - client.tick = packet.response_time - }) + client.on('tick_sync', async packet => { + client.emit('heartbeat', packet.response_time) + client.tick = packet.response_time }) + }) - client.once('close', () => { - clearInterval(keepalive) - }) - } + client.once('close', () => { + clearInterval(keepalive) + }) } async function ping ({ host, port }) { const con = new RakClient({ host, port }) - try { return advertisement.fromServerName(await con.ping()) } finally { diff --git a/src/datatypes/compiler-minecraft.js b/src/datatypes/compiler-minecraft.js index 75fd0b9..3dd9483 100644 --- a/src/datatypes/compiler-minecraft.js +++ b/src/datatypes/compiler-minecraft.js @@ -1,7 +1,7 @@ /* eslint-disable */ const UUID = require('uuid-1345') const minecraft = require('./minecraft') -const [Read, Write, SizeOf] = [{}, {}, {}] +const { Read, Write, SizeOf } = require('./varlong') /** * UUIDs @@ -116,6 +116,74 @@ Read.lnbt = ['native', minecraft.lnbt[0]] Write.lnbt = ['native', minecraft.lnbt[1]] SizeOf.lnbt = ['native', minecraft.lnbt[2]] +/** + * Bits + */ + +Read.bitflags = ['parametrizable', (compiler, { type, flags, shift, big }) => { + let fstr = JSON.stringify(flags) + if (Array.isArray(flags)) { + fstr = '{' + flags.map((v, k) => fstr += `"${v}": ${big ? 1n << BigInt(k) : 1 << k}` + (big ? 'n,' : ',')) + fstr += '}' + } else if (shift) { + fstr = '{' + for (const key in flags) fstr += `"${key}": ${1 << flags[key]},`; + fstr += '}' + } + return compiler.wrapCode(` + const { value: _value, size } = ${compiler.callType(type, 'offset')} + const value = { _value } + const flags = ${fstr} + for (const key in flags) { + value[key] = (_value & flags[key]) == flags[key] + } + return { value, size } + `.trim()) +}] + +Write.bitflags = ['parametrizable', (compiler, { type, flags, shift, big }) => { + let fstr = JSON.stringify(flags) + if (Array.isArray(flags)) { + fstr = '{' + flags.map((v, k) => fstr += `"${v}": ${big ? 1n << BigInt(k) : 1 << k}` + (big ? 'n,' : ',')) + fstr += '}' + } else if (shift) { + fstr = '{' + for (const key in flags) fstr += `"${key}": ${1 << flags[key]},`; + fstr += '}' + } + return compiler.wrapCode(` + const flags = ${fstr} + let val = value._value ${big ? '|| 0n' : ''} + for (const key in flags) { + if (value[key]) val |= flags[key] + } + return (ctx.${type})(val, buffer, offset) + `.trim()) +}] + +SizeOf.bitflags = ['parametrizable', (compiler, { type, flags, shift, big }) => { + let fstr = JSON.stringify(flags) + if (Array.isArray(flags)) { + fstr = '{' + flags.map((v, k) => fstr += `"${v}": ${big ? 1n << BigInt(k) : 1 << k}` + (big ? 'n,' : ',')) + fstr += '}' + } else if (shift) { + fstr = '{' + for (const key in flags) fstr += `"${key}": ${1 << flags[key]},`; + fstr += '}' + } + return compiler.wrapCode(` + const flags = ${fstr} + let val = value._value ${big ? '|| 0n' : ''} + for (const key in flags) { + if (value[key]) val |= flags[key] + } + return (ctx.${type})(val) + `.trim()) +}] + /** * Command Packet * - used for determining the size of the following enum diff --git a/src/datatypes/minecraft.js b/src/datatypes/minecraft.js index 117e5ff..5b93bc0 100644 --- a/src/datatypes/minecraft.js +++ b/src/datatypes/minecraft.js @@ -1,11 +1,14 @@ +/* eslint-disable */ const nbt = require('prismarine-nbt') const UUID = require('uuid-1345') const protoLE = nbt.protos.little const protoLEV = nbt.protos.littleVarint +// TODO: deal with this: +const zigzag = require('prismarine-nbt/compiler-zigzag') function readUUID (buffer, offset) { - if (offset + 16 > buffer.length) { throw new Error('Reached end of buffer') } + if (offset + 16 > buffer.length) { throw new PartialReadError() } return { value: UUID.stringify(buffer.slice(offset, 16 + offset)), size: 16 @@ -62,7 +65,7 @@ function readEntityMetadata (buffer, offset, _ref) { const metadata = [] let item while (true) { - if (offset + 1 > buffer.length) throw new Error('Reached end of buffer') + if (offset + 1 > buffer.length) throw new PartialReadError() item = buffer.readUInt8(cursor) if (item === endVal) { return { @@ -156,5 +159,7 @@ module.exports = { lnbt: [readNbtLE, writeNbtLE, sizeOfNbtLE], entityMetadataLoop: [readEntityMetadata, writeEntityMetadata, sizeOfEntityMetadata], ipAddress: [readIpAddress, writeIpAddress, 4], - endOfArray: [readEndOfArray, writeEndOfArray, sizeOfEndOfArray] + endOfArray: [readEndOfArray, writeEndOfArray, sizeOfEndOfArray], + zigzag32: zigzag.zigzag32, + zigzag64: zigzag.zigzag64 } diff --git a/src/datatypes/varlong.js b/src/datatypes/varlong.js new file mode 100644 index 0000000..5e57ad7 --- /dev/null +++ b/src/datatypes/varlong.js @@ -0,0 +1,63 @@ +function sizeOfVarLong (value) { + if (typeof value.valueOf() === 'object') { + value = (BigInt(value[0]) << 32n) | BigInt(value[1]) + } else if (typeof value !== 'bigint') value = BigInt(value) + + let cursor = 0 + while (value > 127n) { + value >>= 7n + cursor++ + } + return cursor + 1 +} + +/** + * Reads a 64-bit VarInt as a BigInt + */ +function readVarLong (buffer, offset) { + let result = BigInt(0) + let shift = 0n + let cursor = offset + let size = 0 + + while (true) { + if (cursor + 1 > buffer.length) { throw new Error('unexpected buffer end') } + const b = buffer.readUInt8(cursor) + result |= (BigInt(b) & 0x7fn) << shift // Add the bits to our number, except MSB + cursor++ + if (!(b & 0x80)) { // If the MSB is not set, we return the number + size = cursor - offset + break + } + shift += 7n // we only have 7 bits, MSB being the return-trigger + if (shift > 63n) throw new Error(`varint is too big: ${shift}`) + } + + return { value: result, size } +} + +/** + * Writes a zigzag encoded 64-bit VarInt as a BigInt + */ +function writeVarLong (value, buffer, offset) { + // if an array, turn it into a BigInt + if (typeof value.valueOf() === 'object') { + value = BigInt.asIntN(64, (BigInt(value[0]) << 32n)) | BigInt(value[1]) + } else if (typeof value !== 'bigint') value = BigInt(value) + + let cursor = 0 + while (value > 127n) { // keep writing in 7 bit slices + const num = Number(value & 0xFFn) + buffer.writeUInt8(num | 0x80, offset + cursor) + cursor++ + value >>= 7n + } + buffer.writeUInt8(Number(value), offset + cursor) + return offset + cursor + 1 +} + +module.exports = { + Read: { varint64: ['native', readVarLong] }, + Write: { varint64: ['native', writeVarLong] }, + SizeOf: { varint64: ['native', sizeOfVarLong] } +} diff --git a/src/handshake/constants.js b/src/handshake/constants.js index 0362f0f..3e7ef06 100644 --- a/src/handshake/constants.js +++ b/src/handshake/constants.js @@ -1,3 +1,3 @@ module.exports = { - PUBLIC_KEY: 'MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAECRXueJeTDqNRRgJi/vlRufByu/2G0i2Ebt6YMar5QX/R0DIIyrJMcUpruK4QveTfJSTp3Shlq4Gk34cD/4GUWwkv0DVuzeuB+tXija7HBxii03NHDbPAD0AKnLr2wdAp' + PUBLIC_KEY: 'MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAE8ELkixyLcwlZryUQcu1TvPOmI2B7vX83ndnWRUaXm74wFfa5f/lwQNTfrLVHa2PmenpGI6JhIMUJaWZrjmMj90NoKNFSNBuKdm8rYiXsfaz3K36x/1U26HpG0ZxK/V1V' } diff --git a/src/handshake/login.js b/src/handshake/login.js index 8a2830d..3c47e47 100644 --- a/src/handshake/login.js +++ b/src/handshake/login.js @@ -36,6 +36,7 @@ module.exports = (client, server, options) => { client.createClientUserChain = (privateKey) => { let payload = { ...skinData, + SkinGeometryDataEngineVersion: '', // 1.17.30 ClientRandomId: Date.now(), CurrentInputMode: 1, @@ -46,30 +47,23 @@ module.exports = (client, server, options) => { GameVersion: options.version || '1.16.201', GuiScale: -1, LanguageCode: 'en_GB', // TODO locale - GraphicsMode: 1, // 1:simple, 2:fancy, 3:advanced, 4:ray_traced PlatformOfflineId: '', PlatformOnlineId: '', // chat // PlayFabID is the PlayFab ID produced for the skin. PlayFab is the company that hosts the Marketplace, // skins and other related features from the game. This ID is the ID of the skin used to store the skin - // inside of PlayFab.The playfab ID is always lowercased. - PlayFabId: nextUUID().replace(/-/g, '').slice(0, 16).toLowerCase(), // 1.16.210 + // inside of PlayFab. + PlayFabId: nextUUID().replace(/-/g, '').slice(0, 16), // 1.16.210 SelfSignedId: nextUUID(), ServerAddress: `${options.host}:${options.port}`, - ThirdPartyName: client.profile.name, // Gamertag - ThirdPartyNameOnly: client.versionGreaterThanOrEqualTo('1.21.90') ? undefined : false, + ThirdPartyName: client.profile.name, + ThirdPartyNameOnly: false, UIProfile: 0, IsEditorMode: false, - TrustedSkin: client.versionGreaterThanOrEqualTo('1.19.20') ? false : undefined, - OverrideSkin: client.versionGreaterThanOrEqualTo('1.19.62') ? false : undefined, - CompatibleWithClientSideChunkGen: client.versionGreaterThanOrEqualTo('1.19.80') ? false : undefined, - - MaxViewDistance: client.versionGreaterThanOrEqualTo('1.21.42') ? 0 : undefined, - MemoryTier: client.versionGreaterThanOrEqualTo('1.21.42') ? 0 : undefined, - PlatformType: client.versionGreaterThanOrEqualTo('1.21.42') ? 0 : undefined + TrustedSkin: false } const customPayload = options.skinData || {} payload = { ...payload, ...customPayload } diff --git a/src/options.js b/src/options.js index 6e27dbe..8fc973d 100644 --- a/src/options.js +++ b/src/options.js @@ -3,16 +3,16 @@ const mcData = require('minecraft-data') // Minimum supported version (< will be kicked) const MIN_VERSION = '1.16.201' // Currently supported verson. Note, clients with newer versions can still connect as long as data is in minecraft-data -const CURRENT_VERSION = '1.21.111' +const CURRENT_VERSION = '1.19.70' const Versions = Object.fromEntries(mcData.versions.bedrock.filter(e => e.releaseType === 'release').map(e => [e.minecraftVersion, e.version])) // Skip some low priority versions (middle major) on Github Actions to allow faster CI -const skippedVersionsOnGithubCI = ['1.16.210', '1.17.10', '1.17.30', '1.18.11', '1.19.10', '1.19.20', '1.19.30', '1.19.40', '1.19.50', '1.19.60', '1.19.63', '1.19.70', '1.20.10', '1.20.15', '1.20.30', '1.20.40', '1.20.50', '1.20.61', '1.20.71', '1.21.2', '1.21.20', '1.21.30', '1.21.42', '1.21.50', '1.21.60', '1.21.70', '1.21.80', '1.21.90'] +const skippedVersionsOnGithubCI = ['1.16.210', '1.17.10', '1.17.30', '1.18.11', '1.19.10', '1.19.20', '1.19.30', '1.19.40', '1.19.50'] const testedVersions = process.env.CI ? Object.keys(Versions).filter(v => !skippedVersionsOnGithubCI.includes(v)) : Object.keys(Versions) const defaultOptions = { - // https://minecraft.wiki/w/Protocol_version#Bedrock_Edition_2 + // https://minecraft.gamepedia.com/Protocol_version#Bedrock_Edition_2 version: CURRENT_VERSION, // client: If we should send SetPlayerInitialized to the server after getting play_status spawn. // if this is disabled, no 'spawn' event will be emitted, you should manually set diff --git a/src/rak.js b/src/rak.js index fafe27c..ace74af 100644 --- a/src/rak.js +++ b/src/rak.js @@ -68,12 +68,7 @@ class RakNativeClient extends EventEmitter { done(ret.extra.toString()) } }) - }, timeout, () => { - if ('REPLIT_ENVIRONMENT' in process.env) { - console.warn('A Replit environment was detected. Replit may not support the necessary outbound UDP connections required to connect to a Minecraft server. Please see https://github.com/PrismarineJS/bedrock-protocol/blob/master/docs/FAQ.md for more information.') - } - throw new RakTimeout('Ping timed out') - }) + }, timeout, () => { throw new RakTimeout('Ping timed out') }) } connect () { diff --git a/src/relay.js b/src/relay.js index 3128a7d..a5f5638 100644 --- a/src/relay.js +++ b/src/relay.js @@ -49,11 +49,7 @@ class RelayPlayer extends Player { } catch (e) { this.server.deserializer.dumpFailedBuffer(packet, this.connection.address) console.error(this.connection.address, e) - - if (!this.options.omitParseErrors) { - this.disconnect('Server packet parse error') - } - + this.disconnect('Server packet parse error') return } const name = des.data.name @@ -186,15 +182,12 @@ class Relay extends Server { async openUpstreamConnection (ds, clientAddr) { const options = { authTitle: this.options.authTitle, - flow: this.options.flow, - deviceType: this.options.deviceType, offline: this.options.destination.offline ?? this.options.offline, username: this.options.offline ? ds.profile.name : ds.profile.xuid, version: this.options.version, realms: this.options.destination.realms, host: this.options.destination.host, port: this.options.destination.port, - batchingInterval: this.options.batchingInterval, onMsaCode: (code) => { if (this.options.onMsaCode) { this.options.onMsaCode(code, ds) diff --git a/src/server.js b/src/server.js index 0b43fd2..5476455 100644 --- a/src/server.js +++ b/src/server.js @@ -15,7 +15,6 @@ class Server extends EventEmitter { this.RakServer = require('./rak')(this.options.raknetBackend).RakServer - this._loadFeatures(this.options.version) this.serializer = createSerializer(this.options.version) this.deserializer = createDeserializer(this.options.version) this.advertisement = new ServerAdvertisement(this.options.motd, this.options.port, this.options.version) @@ -24,41 +23,25 @@ class Server extends EventEmitter { this.clients = {} this.clientCount = 0 this.conLog = debug - this.batchHeader = 0xfe this.setCompressor(this.options.compressionAlgorithm, this.options.compressionLevel, this.options.compressionThreshold) } - _loadFeatures (version) { - try { - const mcData = require('minecraft-data')('bedrock_' + version) - this.features = { - compressorInHeader: mcData.supportFeature('compressorInPacketHeader'), - newLoginIdentityFields: mcData.supportFeature('newLoginIdentityFields') - } - } catch (e) { - throw new Error(`Unsupported version: '${version}', no data available`) - } - } - setCompressor (algorithm, level = 1, threshold = 256) { switch (algorithm) { case 'none': this.compressionAlgorithm = 'none' this.compressionLevel = 0 - this.compressionHeader = 255 break case 'deflate': this.compressionAlgorithm = 'deflate' this.compressionLevel = level this.compressionThreshold = threshold - this.compressionHeader = 0 break case 'snappy': this.compressionAlgorithm = 'snappy' this.compressionLevel = level this.compressionThreshold = threshold - this.compressionHeader = 1 break default: throw new Error(`Unknown compression algorithm: ${algorithm}`) @@ -90,10 +73,12 @@ class Server extends EventEmitter { this.emit('connect', player) } - onCloseConnection = (conn, reason) => { - this.conLog('Connection closed: ', conn.address, reason) - this.clients[conn.address]?.close() - delete this.clients[conn.address] + onCloseConnection = (inetAddr, reason) => { + this.conLog('Connection closed: ', inetAddr?.address, reason) + + delete this.clients[inetAddr]?.connection // Prevent close loop + this.clients[inetAddr?.address ?? inetAddr]?.close() + delete this.clients[inetAddr] this.clientCount-- } @@ -117,9 +102,8 @@ class Server extends EventEmitter { return this.advertisement } - async listen () { - const { host, port, maxPlayers } = this.options - this.raknet = new this.RakServer({ host, port, maxPlayers }, this) + async listen (host = this.options.host, port = this.options.port) { + this.raknet = new this.RakServer({ host, port }, this) try { await this.raknet.listen() diff --git a/src/serverPlayer.js b/src/serverPlayer.js index 2e8ea77..ffb1961 100644 --- a/src/serverPlayer.js +++ b/src/serverPlayer.js @@ -10,7 +10,6 @@ class Player extends Connection { constructor (server, connection) { super() this.server = server - this.features = server.features this.serializer = server.serializer this.deserializer = server.deserializer this.connection = connection @@ -24,16 +23,14 @@ class Player extends Connection { this.status = ClientStatus.Authenticating if (isDebug) { - this.inLog = (...args) => debug('-> S', ...args) - this.outLog = (...args) => debug('<- S', ...args) + this.inLog = (...args) => debug('S ->', ...args) + this.outLog = (...args) => debug('S <-', ...args) } - this.batchHeader = this.server.batchHeader // Compression is server-wide this.compressionAlgorithm = this.server.compressionAlgorithm this.compressionLevel = this.server.compressionLevel this.compressionThreshold = this.server.compressionThreshold - this.compressionHeader = this.server.compressionHeader this._sentNetworkSettings = false // 1.19.30+ } @@ -51,7 +48,6 @@ class Player extends Connection { client_throttle_scalar: 0 }) this._sentNetworkSettings = true - this.compressionReady = true } handleClientProtocolVersion (clientVersion) { @@ -78,18 +74,11 @@ class Player extends Connection { // Parse login data const tokens = body.params.tokens + const authChain = JSON.parse(tokens.identity) + const skinChain = tokens.client + try { - const skinChain = tokens.client - const authChain = JSON.parse(tokens.identity) - let chain - if (authChain.Certificate) { // 1.21.90+ - chain = JSON.parse(authChain.Certificate).chain - } else if (authChain.chain) { - chain = authChain.chain - } else { - throw new Error('Invalid login packet: missing chain or Certificate') - } - var { key, userData, skinData } = this.decodeLoginJWT(chain, skinChain) // eslint-disable-line + var { key, userData, skinData } = this.decodeLoginJWT(authChain.chain, skinChain) // eslint-disable-line } catch (e) { debug(this.address, e) this.disconnect('Server authentication error') @@ -126,8 +115,7 @@ class Player extends Connection { if (this.status === ClientStatus.Disconnected) return this.write('disconnect', { hide_disconnect_screen: hide, - message: reason, - filtered_message: '' + message: reason }) this.server.conLog('Kicked ', this.connection?.address, reason) setTimeout(() => this.close('kick'), 100) // Allow time for message to be recieved. @@ -164,7 +152,7 @@ class Player extends Connection { return } - this.inLog?.(des.data.name, serialize(des.data.params)) + this.inLog?.(des.data.name, serialize(des.data.params).slice(0, 200)) switch (des.data.name) { // This is the first packet on 1.19.30 & above diff --git a/src/transforms/encryption.js b/src/transforms/encryption.js index ff067cc..b02351b 100644 --- a/src/transforms/encryption.js +++ b/src/transforms/encryption.js @@ -36,10 +36,7 @@ function createEncryptor (client, iv) { // The send counter is represented as a little-endian 64-bit long and incremented after each packet. function process (chunk) { - const compressed = Zlib.deflateRawSync(chunk, { level: client.compressionLevel }) - const buffer = client.features.compressorInHeader - ? Buffer.concat([Buffer.from([0]), compressed]) - : compressed + const buffer = Zlib.deflateRawSync(chunk, { level: client.compressionLevel }) const packet = Buffer.concat([buffer, computeCheckSum(buffer, client.sendCounter, client.secretKeyBytes)]) client.sendCounter++ client.cipher.write(packet) @@ -73,22 +70,7 @@ function createDecryptor (client, iv) { return } - let buffer - if (client.features.compressorInHeader) { - switch (packet[0]) { - case 0: - buffer = Zlib.inflateRawSync(packet.slice(1), { chunkSize: 512000 }) - break - case 255: - buffer = packet.slice(1) - break - default: - client.emit('error', Error(`Unsupported compressor: ${packet[0]}`)) - } - } else { - buffer = Zlib.inflateRawSync(packet, { chunkSize: 512000 }) - } - + const buffer = Zlib.inflateRawSync(chunk, { chunkSize: 512000 }) client.onDecryptedPacket(buffer) } diff --git a/src/transforms/framer.js b/src/transforms/framer.js index a2d9c4f..2452f01 100644 --- a/src/transforms/framer.js +++ b/src/transforms/framer.js @@ -3,15 +3,12 @@ const zlib = require('zlib') // Concatenates packets into one batch packet, and adds length prefixs. class Framer { - constructor (client) { + constructor (compressor, compressionLevel, compressionThreshold) { // Encoding this.packets = [] - this.batchHeader = client.batchHeader - this.compressor = client.compressionAlgorithm || 'none' - this.compressionLevel = client.compressionLevel - this.compressionThreshold = client.compressionThreshold - this.compressionHeader = client.compressionHeader || 0 - this.writeCompressor = client.features.compressorInHeader && client.compressionReady + this.compressor = compressor || 'none' + this.compressionLevel = compressionLevel + this.compressionThreshold = compressionThreshold } // No compression in base class @@ -24,46 +21,30 @@ class Framer { } static decompress (algorithm, buffer) { - switch (algorithm) { - case 0: - case 'deflate': - return zlib.inflateRawSync(buffer, { chunkSize: 512000 }) - case 1: - case 'snappy': - throw Error('Snappy compression not implemented') - case 'none': - case 255: - return buffer - default: throw Error('Unknown compression type ' + algorithm) + try { + switch (algorithm) { + case 'deflate': return zlib.inflateRawSync(buffer, { chunkSize: 512000 }) + case 'snappy': throw Error('Snappy compression not implemented') + case 'none': return buffer + default: throw Error('Unknown compression type ' + this.compressor) + } + } catch { + return buffer } } - static decode (client, buf) { + static decode (compressor, buf) { // Read header - if (this.batchHeader && buf[0] !== this.batchHeader) throw Error(`bad batch packet header, received: ${buf[0]}, expected: ${this.batchHeader}`) + if (buf[0] !== 0xfe) throw Error('bad batch packet header ' + buf[0]) const buffer = buf.slice(1) - // Decompress - let decompressed - if (client.features.compressorInHeader && client.compressionReady) { - decompressed = this.decompress(buffer[0], buffer.slice(1)) - } else { - // On old versions, compressor is session-wide ; failing to decompress - // a packet will assume it's not compressed - try { - decompressed = this.decompress(client.compressionAlgorithm, buffer) - } catch (e) { - decompressed = buffer - } - } + const decompressed = this.decompress(compressor, buffer) return Framer.getPackets(decompressed) } encode () { const buf = Buffer.concat(this.packets) - const shouldCompress = buf.length > this.compressionThreshold - const header = this.batchHeader ? [this.batchHeader] : [] - if (this.writeCompressor) header.push(shouldCompress ? this.compressionHeader : 255) - return Buffer.concat([Buffer.from(header), shouldCompress ? this.compress(buf) : buf]) + const compressed = (buf.length > this.compressionThreshold) ? this.compress(buf) : buf + return Buffer.concat([Buffer.from([0xfe]), compressed]) } addEncodedPacket (chunk) { diff --git a/src/transforms/serializer.js b/src/transforms/serializer.js index 8fffc42..e025654 100644 --- a/src/transforms/serializer.js +++ b/src/transforms/serializer.js @@ -37,6 +37,7 @@ function createProtocol (version) { const compiler = new ProtoDefCompiler() compiler.addTypesToCompile(protocol.types) compiler.addTypes(require('../datatypes/compiler-minecraft')) + compiler.addTypes(require('prismarine-nbt/compiler-zigzag')) const compiledProto = compiler.compileProtoDefSync() return compiledProto @@ -46,6 +47,7 @@ function createProtocol (version) { function getProtocol (version) { const compiler = new ProtoDefCompiler() compiler.addTypes(require(join(__dirname, '../datatypes/compiler-minecraft'))) + compiler.addTypes(require('prismarine-nbt/compiler-zigzag')) global.PartialReadError = require('protodef/src/utils').PartialReadError const compile = (compiler, file) => require(file)(compiler.native) diff --git a/test/internal.js b/test/internal.js index ffb403e..5af64b1 100644 --- a/test/internal.js +++ b/test/internal.js @@ -14,7 +14,7 @@ function prepare (version) { async function startTest (version = CURRENT_VERSION, ok) { await prepare(version) - // const Item = require('../types/Item')(version) + const Item = require('../types/Item')(version) const port = await getPort() const server = new Server({ host: '0.0.0.0', port, version, offline: true }) @@ -47,9 +47,7 @@ async function startTest (version = CURRENT_VERSION, ok) { must_accept: false, has_scripts: false, behaviour_packs: [], - world_template: { uuid: '550e8400-e29b-41d4-a716-446655440000', version: '' }, // 1.21.50 - texture_packs: [], - resource_pack_links: [] + texture_packs: [] }) client.once('resource_pack_client_response', async rp => { @@ -57,17 +55,13 @@ async function startTest (version = CURRENT_VERSION, ok) { client.write('network_settings', { compression_threshold: 1 }) // Send some inventory slots for (let i = 0; i < 3; i++) { - // client.queue('inventory_slot', { window_id: 'armor', slot: 0, item: new Item().toBedrock() }) + client.queue('inventory_slot', { window_id: 'armor', slot: 0, item: new Item().toBedrock() }) } // client.queue('inventory_transaction', get('packets/inventory_transaction.json')) client.queue('player_list', get('packets/player_list.json')) client.queue('start_game', get('packets/start_game.json')) - if (client.versionLessThan('1.21.60')) { - client.queue('item_component', { entries: [] }) - } else { - client.queue('item_registry', get('packets/item_registry.json')) - } + client.queue('item_component', { entries: [] }) client.queue('set_spawn_position', get('packets/set_spawn_position.json')) client.queue('set_time', { time: 5433771 }) client.queue('set_difficulty', { difficulty: 1 }) @@ -101,11 +95,11 @@ async function startTest (version = CURRENT_VERSION, ok) { loop = setInterval(() => { client.write('network_chunk_publisher_update', { coordinates: { x: 646, y: 130, z: 77 }, radius: 64 }) - }, 6500) + }, 9500) setTimeout(() => { client.write('play_status', { status: 'player_spawn' }) - }, 3000) + }, 6000) // Respond to tick synchronization packets client.on('tick_sync', (packet) => { diff --git a/test/internal.test.js b/test/internal.test.js index 271a7c5..1b6250c 100644 --- a/test/internal.test.js +++ b/test/internal.test.js @@ -3,7 +3,6 @@ const { timedTest } = require('./internal') const { testedVersions } = require('../src/options') const { sleep } = require('../src/datatypes/util') -require('events').captureRejections = true describe('internal client/server test', function () { const vcount = testedVersions.length diff --git a/test/proxy.js b/test/proxy.js index af443d7..55878d5 100644 --- a/test/proxy.js +++ b/test/proxy.js @@ -2,7 +2,7 @@ const { createClient, Server, Relay } = require('bedrock-protocol') const { sleep, waitFor } = require('../src/datatypes/util') const { getPort } = require('./util') -function proxyTest (version, raknetBackend = 'raknet-native', timeout = 1000 * 40) { +function proxyTest (version, raknetBackend = 'raknet-node', timeout = 1000 * 40) { console.log('with raknet backend', raknetBackend) return waitFor(async res => { const SERVER_PORT = await getPort() @@ -22,12 +22,12 @@ function proxyTest (version, raknetBackend = 'raknet-native', timeout = 1000 * 4 console.debug('Client has authenticated') setTimeout(() => { client.disconnect('Hello world !') - }, 500) // allow some time for client to connect + }, 1000) // allow some time for client to connect }) }) console.debug('Server started', server.options.version) - await new Promise(resolve => setTimeout(resolve, 500)) + await new Promise(resolve => setTimeout(resolve, 1000)) const relay = new Relay({ version, @@ -46,7 +46,7 @@ function proxyTest (version, raknetBackend = 'raknet-native', timeout = 1000 * 4 await relay.listen() console.debug('Proxy started', server.options.version) - await new Promise(resolve => setTimeout(resolve, 500)) + await new Promise(resolve => setTimeout(resolve, 1000)) const client = createClient({ host: '127.0.0.1', port: CLIENT_PORT, version, username: 'Boat', offline: true, raknetBackend, skipPing: true }) console.debug('Client started') @@ -58,7 +58,7 @@ function proxyTest (version, raknetBackend = 'raknet-native', timeout = 1000 * 4 server.close() relay.close() console.log('✔ OK') - sleep(200).then(res) + sleep(500).then(res) }) }, timeout, () => { throw Error('timed out') }) } diff --git a/test/proxy.test.js b/test/proxy.test.js index 27761ae..70ea5f1 100644 --- a/test/proxy.test.js +++ b/test/proxy.test.js @@ -11,7 +11,7 @@ describe('proxies client/server', function () { it('proxies ' + version, async () => { console.debug(version) await proxyTest(version) - await sleep(100) + await sleep(1000) console.debug('Done', version) }) } diff --git a/test/util.js b/test/util.js index 3325863..2876a67 100644 --- a/test/util.js +++ b/test/util.js @@ -5,12 +5,7 @@ const getPort = () => new Promise(resolve => { server.listen(0, '127.0.0.1') server.on('listening', () => { const { port } = server.address() - server.close(() => { - // Wait a bit for port to free as we try to bind right after freeing it - setTimeout(() => { - resolve(port) - }, 200) - }) + server.close(() => resolve(port)) }) }) diff --git a/test/vanilla.js b/test/vanilla.js index 73a5f44..ca82d3d 100644 --- a/test/vanilla.js +++ b/test/vanilla.js @@ -5,12 +5,11 @@ const { waitFor } = require('../src/datatypes/util') const { getPort } = require('./util') async function test (version) { - // const ChunkColumn = require('bedrock-provider').chunk('bedrock_' + (version.includes('1.19') ? '1.18.30' : version)) // TODO: Fix prismarine-chunk + const ChunkColumn = require('bedrock-provider').chunk('bedrock_' + (version.includes('1.19') ? '1.18.30' : version)) // TODO: Fix prismarine-chunk // Start the server, wait for it to accept clients, throws on timeout - const [port, v6] = [await getPort(), await getPort()] - console.log('Starting vanilla server', version, 'on port', port, v6) - const handle = await vanillaServer.startServerAndWait2(version, 1000 * 220, { 'server-port': port, 'server-portv6': v6 }) + const port = await getPort() + const handle = await vanillaServer.startServerAndWait2(version, 1000 * 220, { 'server-port': port }) console.log('Started server') const client = new Client({ @@ -18,7 +17,7 @@ async function test (version) { port, username: 'Notch', version, - raknetBackend: 'raknet-native', + raknetBackend: 'raknet-node', offline: true }) @@ -49,10 +48,10 @@ async function test (version) { client.queue('tick_sync', { request_time: BigInt(Date.now()), response_time: BigInt(Date.now()) }) }, 200) - // client.on('level_chunk', async packet => { // Chunk read test - // const cc = new ChunkColumn(packet.x, packet.z) - // await cc.networkDecodeNoCache(packet.payload, packet.sub_chunk_count) - // }) + client.on('level_chunk', async packet => { // Chunk read test + const cc = new ChunkColumn(packet.x, packet.z) + await cc.networkDecodeNoCache(packet.payload, packet.sub_chunk_count) + }) console.log('Awaiting join') diff --git a/tools/compileProtocol.js b/tools/compileProtocol.js index a7c3aa0..a51cfc1 100644 --- a/tools/compileProtocol.js +++ b/tools/compileProtocol.js @@ -15,6 +15,7 @@ function createProtocol (version) { const compiler = new ProtoDefCompiler() const protocol = mcData('bedrock_' + version).protocol.types compiler.addTypes(require('../src/datatypes/compiler-minecraft')) + compiler.addTypes(require('prismarine-nbt/compiler-zigzag')) compiler.addTypesToCompile(protocol) fs.writeFileSync('./read.js', 'module.exports = ' + compiler.readCompiler.generate().replace('() =>', 'native =>')) @@ -38,7 +39,7 @@ require('minecraft-data/bin/generate_data') // If no argument, build everything if (!process.argv[2]) { - convert('bedrock', 'latest') + convert('latest') for (const version of versions) { main(version) } diff --git a/tools/genPacketDumps.js b/tools/genPacketDumps.js index f0edbfe..b9c5909 100644 --- a/tools/genPacketDumps.js +++ b/tools/genPacketDumps.js @@ -10,11 +10,9 @@ const { getPort } = require('../test/util') function hasDumps (version) { const root = join(__dirname, `../data/${version}/sample/packets/`) - if (!fs.existsSync(root) || getFiles(root).length < 10) { return false } - return true } @@ -24,7 +22,7 @@ async function dump (version, force = true) { const random = (Math.random() * 1000) | 0 const [port, v6] = [await getPort(), await getPort()] - console.log('Starting dump server', version, 'on port', port, v6) + console.log('Starting dump server', version) const handle = await vanillaServer.startServerAndWait2(version || CURRENT_VERSION, 1000 * 120, { 'server-port': port, 'server-portv6': v6 }) console.log('Started dump server', version) @@ -32,15 +30,16 @@ async function dump (version, force = true) { host: '127.0.0.1', port, version, - username: 'Packet' + random, + username: 'Boat' + random, offline: true }) client.connect() return waitFor(async res => { const root = join(__dirname, `../data/${client.options.version}/sample/`) - - fs.mkdirSync(root + 'packets', { recursive: true }) - fs.mkdirSync(root + 'chunks', { recursive: true }) + if (!fs.existsSync(root + 'packets') || !fs.existsSync(root + 'chunks')) { + fs.mkdirSync(root + 'packets', { recursive: true }) + fs.mkdirSync(root + 'chunks', { recursive: true }) + } client.once('resource_packs_info', (packet) => { client.write('resource_pack_client_response', { @@ -57,9 +56,9 @@ async function dump (version, force = true) { client.queue('client_cache_status', { enabled: false }) client.queue('request_chunk_radius', { chunk_radius: 1 }) + // client.queue('tick_sync', { request_time: BigInt(Date.now()), response_time: 0n }) clearInterval(loop) - loop = setInterval(() => { client.queue('tick_sync', { request_time: BigInt(Date.now()), response_time: BigInt(Date.now()) }) }, 200) @@ -69,12 +68,10 @@ async function dump (version, force = true) { client.on('packet', async packet => { // Packet dumping const { name, params } = packet.data - if (name === 'level_chunk') { fs.writeFileSync(root + `chunks/${name}-${i++}.bin`, packet.buffer) return } - try { if (!fs.existsSync(root + `packets/${name}.json`) || force) { fs.writeFileSync(root + `packets/${name}.json`, serialize(params, 2)) @@ -86,7 +83,6 @@ async function dump (version, force = true) { client.on('spawn', () => { console.log('Spawned!') - clearInterval(loop) client.close() handle.kill() @@ -95,7 +91,7 @@ async function dump (version, force = true) { }, 1000 * 60, () => { clearInterval(loop) handle.kill() - throw Error('Timed out') + throw Error('timed out') }) } diff --git a/tools/installPMMP.sh b/tools/installPMMP.sh deleted file mode 100644 index 28a7101..0000000 --- a/tools/installPMMP.sh +++ /dev/null @@ -1,8 +0,0 @@ -rm -fr pmmp -mkdir pmmp && cd pmmp -wget https://github.com/pmmp/PHP-Binaries/releases/download/php-8.1-latest/PHP-Linux-x86_64-PM5.tar.gz -tar -xvf PHP-Linux-x86_64-PM5.tar.gz bin/ -git clone https://github.com/pmmp/PocketMine-MP.git -cd PocketMine-MP -../bin/php7/bin/php /usr/bin/composer install -../bin/php7/bin/php src/PocketMine.php --no-wizard --xbox-auth=0 --settings.enable-dev-builds=1 --anonymous-statistics.enabled=0 --disable-readline --debug.level=2 \ No newline at end of file diff --git a/tools/startVanillaServer.js b/tools/startVanillaServer.js index 828e332..c6d4769 100644 --- a/tools/startVanillaServer.js +++ b/tools/startVanillaServer.js @@ -1,11 +1,156 @@ -const bedrockServer = require('minecraft-bedrock-server') +const http = require('https') +const fs = require('fs') +const cp = require('child_process') +const debug = process.env.CI ? console.debug : require('debug')('minecraft-protocol') +const https = require('https') +const { getFiles, waitFor } = require('../src/datatypes/util') -module.exports = { - ...bedrockServer, - startServerAndWait (version, withTimeout, options) { - return bedrockServer.startServerAndWait(version, withTimeout, { ...options, root: __dirname }) - }, - startServerAndWait2 (version, withTimeout, options) { - return bedrockServer.startServerAndWait2(version, withTimeout, { ...options, root: __dirname }) +function head (url) { + return new Promise((resolve, reject) => { + const req = http.request(url, { method: 'HEAD', timeout: 500 }, resolve) + req.on('error', reject) + req.on('timeout', () => { req.destroy(); debug('HEAD request timeout'); reject(new Error('timeout')) }) + req.end() + }) +} +function get (url, outPath) { + const file = fs.createWriteStream(outPath) + return new Promise((resolve, reject) => { + https.get(url, { timeout: 1000 * 20 }, response => { + if (response.statusCode !== 200) return reject(new Error('Server returned code ' + response.statusCode)) + response.pipe(file) + file.on('finish', () => { + file.close() + resolve() + }) + }) + }) +} + +// Get the latest versions +// TODO: once we support multi-versions +function fetchLatestStable () { + get('https://raw.githubusercontent.com/minecraft-linux/mcpelauncher-versiondb/master/versions.json', 'versions.json') + const versions = JSON.parse(fs.readFileSync('./versions.json')) + const latest = versions[0] + return latest.version_name +} + +// Download + extract vanilla server and enter the directory +async function download (os, version, path = 'bds-') { + debug('Downloading server', os, version, 'into', path) + process.chdir(__dirname) + const verStr = version.split('.').slice(0, 3).join('.') + const dir = path + version + + if (fs.existsSync(dir) && getFiles(dir).length) { + process.chdir(path + version) // Enter server folder + return verStr + } + try { fs.mkdirSync(dir) } catch { } + + process.chdir(path + version) // Enter server folder + const url = (os, version) => `https://minecraft.azureedge.net/bin-${os}/bedrock-server-${version}.zip` + + let found = false + + for (let i = 0; i < 8; i++) { // Check for the latest server build for version (major.minor.patch.BUILD) + const u = url(os, `${verStr}.${String(i).padStart(2, '0')}`) + debug('Opening', u, Date.now()) + let ret + try { ret = await head(u) } catch (e) { continue } + if (ret.statusCode === 200) { + found = u + debug('Found server', ret.statusCode) + break + } + } + if (!found) throw Error('did not find server bin for ' + os + ' ' + version) + console.info('🔻 Downloading', found) + await get(found, 'bds.zip') + console.info('⚡ Unzipping') + // Unzip server + if (process.platform === 'linux') cp.execSync('unzip -u bds.zip && chmod +777 ./bedrock_server') + else cp.execSync('tar -xf bds.zip') + return verStr +} + +const defaultOptions = { + 'level-generator': '2', + 'server-port': '19130', + 'online-mode': 'false' +} + +// Setup the server +function configure (options = {}) { + const opts = { ...defaultOptions, ...options } + let config = fs.readFileSync('./server.properties', 'utf-8') + config += '\nplayer-idle-timeout=1\nallow-cheats=true\ndefault-player-permission-level=operator' + for (const o in opts) config += `\n${o}=${opts[o]}` + fs.writeFileSync('./server.properties', config) +} + +function run (inheritStdout = true) { + const exe = process.platform === 'win32' ? 'bedrock_server.exe' : './bedrock_server' + return cp.spawn(exe, inheritStdout ? { stdio: 'inherit' } : {}) +} + +let lastHandle + +// Run the server +async function startServer (version, onStart, options = {}) { + const os = process.platform === 'win32' ? 'win' : process.platform + if (os !== 'win' && os !== 'linux') { + throw Error('unsupported os ' + os) + } + await download(os, version, options.path) + configure(options) + const handle = lastHandle = run(!onStart) + handle.on('error', (...a) => { + console.warn('*** THE MINECRAFT PROCESS CRASHED ***', a) + handle.kill('SIGKILL') + }) + if (onStart) { + let stdout = '' + handle.stdout.on('data', data => { + stdout += data + if (stdout.includes('Server started')) onStart() + }) + handle.stdout.pipe(process.stdout) + handle.stderr.pipe(process.stdout) + } + return handle +} + +// Start the server and wait for it to be ready, with a timeout +async function startServerAndWait (version, withTimeout, options) { + let handle + await waitFor(async res => { + handle = await startServer(version, res, options) + }, withTimeout, () => { + handle?.kill() + throw new Error(`Server did not start on time (${withTimeout}ms, now ${Date.now()})`) + }) + return handle +} + +async function startServerAndWait2 (version, withTimeout, options) { + try { + return await startServerAndWait(version, 1000 * 60, options) + } catch (e) { + console.log(e) + console.log('^ Tring once more to start server in 10 seconds...') + lastHandle?.kill() + await new Promise(resolve => setTimeout(resolve, 10000)) + process.chdir(__dirname) + fs.rmSync('bds-' + version, { recursive: true }) + return await startServerAndWait(version, withTimeout, options) } } + +if (!module.parent) { + // if (process.argv.length < 3) throw Error('Missing version argument') + startServer(process.argv[2] || '1.17.10', null, process.argv[3] ? { 'server-port': process.argv[3], 'online-mode': !!process.argv[4] } : undefined) +} + +module.exports = { fetchLatestStable, startServer, startServerAndWait, startServerAndWait2 }