bedrock-portal 0.8.8 → 0.8.9

package/README.md

@@ -59,6 +59,46 @@ main();
 
 Modules are used to extend the functionality of the BedrockPortal class.
 
+### ServerFormList
+
+Instead of redirecting players to a server, the portal will display a list of servers to join from a form. `#.use(Modules.serverFormList, options);`
+
+Options:
+- **form**: Form - The form to display to the player. At the moment only simple forms are supported. (required)
+- **timeout**: number - The time in milliseconds before the player is kicked from the session if they don't select a server (default: 60000ms)
+- **timeoutMessage**: string - The message to display to the player when they are kicked from the session (default: 'You took too long to select a server!')
+
+The form will be sent to the player when they join the server and every 5 seconds after they clost the form.
+
+```js
+const { BedrockPortal, Joinability, Modules } = require('bedrock-portal')
+const { Authflow, Titles } = require('prismarine-auth')
+
+const main = async () => {
+  const auth = new Authflow('example', './', { authTitle: Titles.XboxAppIOS, deviceType: 'iOS', flow: 'sisu' })
+
+  const portal = new BedrockPortal(auth)
+
+  portal.use(Modules.ServerFromList, {
+    form: {
+      title: '§l§aServer Form List',
+      content: '§7Please select a server to join',
+      buttons: [
+        { text: '§8Anarchy Server\n§7Click Here§!', ip: 'bedrock.opblocks.com', port: 19132 },
+        { text: '§7Creative Server\n§7Click Here§', ip: 'bedrock.opblocks.com', port: 19132 },
+        { text: '§6Survival Server\n§7Click Here§!', ip: 'bedrock.opblocks.com', port: 19132 },
+      ],
+    },
+    timeout: 60000,
+    timeoutMessage: '§cYou took too long to select a server!',
+  })
+
+  await portal.start()
+}
+
+main()
+```
+
 ### MultipleAccounts
 
 Allows the portal to use multiple accounts to redirect players to the server. `#.use(Modules.MultipleAccounts, options);`

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import type { Message } from './types/xblmessaging';
 import { EventResponse } from 'xbox-rta';
 import { Authflow } from 'prismarine-auth';
 import { TypedEmitter } from 'tiny-typed-emitter';
+import { Server } from 'bedrock-portal-nethernet';
 import Host from './classes/Host';
 import Player from './classes/Player';
 import Module from './classes/Module';
@@ -13,6 +14,7 @@ import RedirectFromRealm from './modules/redirectFromRealm';
 import MultipleAccounts from './modules/multipleAccounts';
 import AutoFriendAccept from './modules/autoFriendAccept';
 import UpdateMemberCount from './modules/updateMemberCount';
+import ServerFromList from './modules/serverFormList';
 type BedrockPortalOptions = {
     /**
      * The ip of the server to redirect users to.
@@ -103,7 +105,8 @@ export declare class BedrockPortal extends TypedEmitter<PortalEvents> {
     };
     players: Map<string, Player>;
     modules: Map<string, Module>;
-    constructor(authflow: Authflow, options: Partial<BedrockPortalOptions>);
+    server: Server;
+    constructor(authflow: Authflow, options?: Partial<BedrockPortalOptions>);
     validateOptions(options: BedrockPortalOptions): void;
     /**
      * Starts the BedrockPortal instance.
@@ -148,6 +151,7 @@ export declare class BedrockPortal extends TypedEmitter<PortalEvents> {
      * })
      */
     use(mod: ExtendedModule, options?: {}): void;
+    onServerConnection: (client: any) => void;
     private createAndPublishSession;
     private createSessionBody;
 }
@@ -160,5 +164,6 @@ declare const Modules: {
     MultipleAccounts: typeof MultipleAccounts;
     AutoFriendAccept: typeof AutoFriendAccept;
     UpdateMemberCount: typeof UpdateMemberCount;
+    ServerFromList: typeof ServerFromList;
 };
 export { Modules };

package/dist/index.js

@@ -19,6 +19,7 @@ const redirectFromRealm_1 = __importDefault(require("./modules/redirectFromRealm
 const multipleAccounts_1 = __importDefault(require("./modules/multipleAccounts"));
 const autoFriendAccept_1 = __importDefault(require("./modules/autoFriendAccept"));
 const updateMemberCount_1 = __importDefault(require("./modules/updateMemberCount"));
+const serverFormList_1 = __importDefault(require("./modules/serverFormList"));
 const start_game_1 = require("./common/start_game");
 const util_1 = require("./common/util");
 const debug = (0, debug_1.default)('bedrock-portal');
@@ -29,10 +30,11 @@ class BedrockPortal extends tiny_typed_emitter_1.TypedEmitter {
     session;
     players;
     modules = new Map();
-    constructor(authflow, options) {
+    server = new bedrock_portal_nethernet_1.Server();
+    constructor(authflow, options = {}) {
         super();
         this.options = {
-            ip: '',
+            ip: 'bedrock.opblocks.com',
             port: 19132,
             joinability: constants_1.Joinability.FriendsOfFriends,
             webRTCNetworkId: (0, util_1.getRandomUint64)(),
@@ -54,10 +56,6 @@ class BedrockPortal extends tiny_typed_emitter_1.TypedEmitter {
         this.modules = new Map();
     }
     validateOptions(options) {
-        if (!options.ip)
-            throw new Error('No IP provided');
-        if (!options.port)
-            throw new Error('No port provided');
         if (!Object.values(constants_1.Joinability).includes(options.joinability))
             throw new Error('Invalid joinability - Expected one of ' + Object.keys(constants_1.Joinability).join(', '));
     }
@@ -68,22 +66,13 @@ class BedrockPortal extends tiny_typed_emitter_1.TypedEmitter {
         this.players = new Map();
         await this.host.connect();
         this.session.name = (0, uuid_1.v4)();
-        const server = new bedrock_portal_nethernet_1.Server({
-            version: '1.21.30', // The server version
-            compressionAlgorithm: 'none',
-        });
-        server.listen(this.authflow, this.options.webRTCNetworkId);
-        server.on('connect', client => {
-            client.on('join', () => {
-                console.log(`Client ${client.id} has joined the server.`);
-                client.write('start_game', start_game_1.start_game);
-                client.once('set_player_game_type', () => {
-                    client.write('transfer', { server_address: this.options.ip, port: this.options.port });
-                });
-            });
-        });
+        await this.server.listen(this.authflow, this.options.webRTCNetworkId);
+        this.server.on('connect', (client) => this.onServerConnection(client));
         const session = await this.createAndPublishSession();
-        this.host.rta.on('event', (event) => (0, Event_1.default)(this, event));
+        this.host.rta.on('event', (event) => {
+            (0, Event_1.default)(this, event)
+                .catch(e => debug('Failed to handle event', e));
+        });
         if (this.modules) {
             for (const mod of this.modules.values()) {
                 mod.run(this)
@@ -174,6 +163,14 @@ class BedrockPortal extends tiny_typed_emitter_1.TypedEmitter {
         constructed.applyOptions(options);
         this.modules.set(constructed.name, constructed);
     }
+    onServerConnection = (client) => {
+        client.once('join', () => {
+            client.write('start_game', start_game_1.start_game);
+            client.once('set_player_game_type', () => {
+                client.write('transfer', { server_address: this.options.ip, port: this.options.port });
+            });
+        });
+    };
     async createAndPublishSession() {
         await this.updateSession(this.createSessionBody());
         debug(`Created session, name: ${this.session.name}, ID: ${this.options.webRTCNetworkId}`);
@@ -257,5 +254,6 @@ const Modules = {
     MultipleAccounts: multipleAccounts_1.default,
     AutoFriendAccept: autoFriendAccept_1.default,
     UpdateMemberCount: updateMemberCount_1.default,
+    ServerFromList: serverFormList_1.default,
 };
 exports.Modules = Modules;

package/dist/modules/serverFormList.d.ts

@@ -0,0 +1,10 @@
+import { BedrockPortal } from '..';
+import Module from '../classes/Module';
+export default class ServerFromList extends Module {
+    private n;
+    constructor();
+    run(portal: BedrockPortal): Promise<void>;
+    private sendForm;
+    private handleJoin;
+    private handleFormResponse;
+}

package/dist/modules/serverFormList.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Module_1 = __importDefault(require("../classes/Module"));
+const start_game_1 = require("../common/start_game");
+class ServerFromList extends Module_1.default {
+    n;
+    constructor() {
+        super('serverFromList', 'Allows players to join the server from a list of servers');
+        this.options = {
+            form: {
+                title: '§l§aServer Form List',
+                content: '§7Please select a server to join',
+                buttons: [
+                    { text: '§8Anarchy Server\n§7Click Here§!', ip: 'bedrock.opblocks.com', port: 19132 },
+                    { text: '§7Creative Server\n§7Click Here§', ip: 'bedrock.opblocks.com', port: 19132 },
+                    { text: '§6Survival Server\n§7Click Here§!', ip: 'bedrock.opblocks.com', port: 19132 },
+                ],
+            },
+            timeout: 60000,
+            timeoutMessage: '§cYou took too long to respond',
+        };
+        this.n = 0;
+    }
+    async run(portal) {
+        portal.onServerConnection = (client) => {
+            client.once('join', () => this.handleJoin(client));
+            client.on('spawn', () => {
+                this.sendForm(client);
+            });
+            setTimeout(() => {
+                client.disconnect(this.options.timeoutMessage);
+            }, this.options.timeout);
+        };
+    }
+    sendForm(client) {
+        client.write('modal_form_request', {
+            form_id: this.n++,
+            data: JSON.stringify({
+                type: 'form',
+                title: this.options.form.title,
+                content: this.options.form.content,
+                buttons: this.options.form.buttons.map((button) => ({ text: button.text })),
+            }),
+        });
+    }
+    handleJoin(client) {
+        client.write('resource_packs_info', { must_accept: false, has_addons: false, has_scripts: false, texture_packs: [], resource_pack_links: [] });
+        client.write('resource_pack_stack', { must_accept: false, behavior_packs: [], resource_packs: [], game_version: '', experiments: [], experiments_previously_used: false });
+        client.once('resource_pack_client_response', async () => {
+            client.write('start_game', start_game_1.start_game);
+            client.write('play_status', { status: 'player_spawn' });
+        });
+        client.on('modal_form_response', (p) => this.handleFormResponse(p, client));
+    }
+    handleFormResponse(response, client) {
+        if (response.has_cancel_reason) {
+            setInterval(() => this.sendForm(client), 5000);
+            return;
+        }
+        const server = this.options.form.buttons[parseInt(response.data)];
+        client.write('transfer', { server_address: server.ip, port: server.port });
+    }
+}
+exports.default = ServerFromList;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bedrock-portal",
-  "version": "0.8.8",
+  "version": "0.8.9",
   "description": "Creates a joinable session in Minecraft Bedrock Edition that can route players to their a specified host",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",