pw-js-world 0.0.1

package/lib/Player.ts

@@ -0,0 +1,317 @@
+import type { ProtoGen } from "pw-js-api";
+import type { Point } from "./types";
+
+export interface IPlayer {
+    /**
+     * ID of the player.
+     */
+    playerId: number;
+    /**
+     * ID of the player's account.
+     */
+    accountId: string;
+    /**
+     * Name of the player.
+     */
+    username: string;
+    /**
+     * ID of the player's equipped smiley.
+     */
+    face: number;
+    /**
+     * String, could be an admin or developer.
+     */
+    role: string;
+    /**
+     * If player is bot user's friend.
+     */
+    isFriend: boolean;
+    /**
+     * Position of the user.
+     * 
+     * Note: This helper does not simulate physics so positions will always be inaccurate.
+     */
+    position?: Point;
+    /**
+     * If player is the world owner.
+     */
+    isWorldOwner: boolean;
+    /**
+     * Rights
+     */
+    rights: IPlayerRights;
+    /**
+     * current world state.
+     */
+    states: IPlayerWorldState;
+
+    /**
+     * List of active effects the player has.
+     */
+    effects: PlayerEffect[];
+
+    /**
+     * If this player is the bot.
+     */
+    isMe: boolean;
+}
+
+export interface IPlayerRights {
+    /**
+     * If the player has edit rights.
+     */
+    canEdit: boolean;
+    /**
+     * If the player has god rights.
+     */
+    canGod: boolean;
+    /**
+     * If the player has the ability to toggle minimap.
+     */
+    canToggleMinimap: boolean;
+    /**
+     * If the player has the ability to change the world settings.
+     */
+    canChangeWorldSettings: boolean;
+    /**
+     * List of commands (string) the player can use.
+     */
+    availableCommands: string[];
+}
+
+export interface IPlayerWorldState {
+    /**
+     * Number of gold coins the player has.
+     */
+    coinsGold: number;
+    /**
+     * Number of blue coins the player has.
+     */
+    coinsBlue: number;
+    /**
+     * Number of times the player died.
+     */
+    deaths: number;
+    /**
+     * Coordinates of collected coins?
+     */
+    collectedItems: Point[];
+    /**
+     * If player has gold crown on.
+     */
+    hasGoldCrown: boolean;
+    /**
+     * If player has won the world.
+     */
+    hasSilverCrown: boolean;
+    /**
+     * Zero indexed, map of the player's switch state.
+     */
+    switches: boolean[];
+    /**
+     * If player is in god mode right now.
+     */
+    godmode: boolean;
+    /**
+     * If player is in mod mode right now.
+     */
+    modmode: boolean;
+    /**
+     * ID of the team the player is associated with right now.
+     */
+    teamId: number;
+}
+
+export interface IPlayerEffect {
+    /**
+     * The ID of the effect.
+     */
+    effectId: number;
+    /**
+     * If applicable, the duration of the effect.
+     */
+    duration?: number;
+    /**
+     * If applicable, the strength of the effect. (For example speed or multi jump effect)
+     */
+    strength?: number;
+}
+
+export default class Player {
+    /**
+     * ID of the player.
+     */
+    playerId: number;
+    /**
+     * ID of the player's account.
+     */
+    accountId: string;
+    /**
+     * Name of the player.
+     */
+    username: string;
+    /**
+     * ID of the player's equipped smiley.
+     */
+    face: number;
+    /**
+     * String, could be an admin or developer.
+     */
+    role: string;
+    /**
+     * If player is bot user's friend.
+     */
+    isFriend: boolean;
+    /**
+     * Position of the user.
+     * 
+     * Note: This helper does not simulate physics so positions will always be inaccurate.
+     */
+    position?: Point;
+    /**
+     * If player is the world owner.
+     */
+    isWorldOwner: boolean;
+    /**
+     * Rights
+     */
+    rights!: IPlayerRights;
+    /**
+     * current world state.
+     */
+    states!: IPlayerWorldState;
+
+    /**
+     * List of active effects the player has.
+     */
+    effects:PlayerEffect[] = [];
+
+    /**
+     * If this player is the bot.
+     */
+    isMe: boolean = false;
+
+    constructor(props: ProtoGen.PlayerProperties, states?: IPlayerWorldState | boolean) {
+        this.accountId = props.accountId;
+        this.face = props.face;
+        this.isFriend = props.isFriend;
+        this.isWorldOwner = props.isWorldOwner;
+        this.playerId = props.playerId;
+        this.position = props.position ? {
+            x: props.position.x,
+            y: props.position.y
+        } : undefined;
+
+        if (!props.rights) this.resetRights();
+        else this.rights = {
+            availableCommands: props.rights.availableCommands,
+            canChangeWorldSettings: props.rights.canChangeWorldSettings,
+            canEdit: props.rights.canEdit,
+            canGod: props.rights.canGod,
+            canToggleMinimap: props.rights.canToggleMinimap,
+        };
+
+        this.role = props.role;
+        this.username = props.username;
+
+        if (typeof states === "boolean") {
+            this.isMe = states;
+            states = undefined;
+        }
+
+        if (!states) {
+            // Could be bot via init that don't get states.
+            this.resetState()
+        } else this.states = {
+            coinsBlue: states.coinsBlue,
+            coinsGold: states.coinsGold,
+            collectedItems: states.collectedItems.map(v => ({ x: v.x, y: v.y })),
+            deaths: states.deaths,
+            godmode: states.godmode,
+            hasGoldCrown: states.hasGoldCrown,
+            hasSilverCrown: states.hasSilverCrown,
+            modmode: states.modmode,
+            switches: states.switches,
+            teamId: states.teamId,
+        };
+    }
+
+    /**
+     * This is destructive, this is only for on reset packet.
+     */
+    resetState() {
+        this.states = {
+            coinsBlue: 0,
+            coinsGold: 0,
+            collectedItems: [],
+            deaths: 0,
+            godmode: false,
+            hasGoldCrown: false,
+            hasSilverCrown: false,
+            modmode: false,
+            switches: new Array(1000).fill(false),
+            teamId: 0,
+        }
+    }
+
+    /**
+     * Destructive.
+     */
+    resetRights() {
+        this.rights = {
+            availableCommands: [],
+            canChangeWorldSettings: false,
+            canEdit: false,
+            canGod: false,
+            canToggleMinimap: false
+        }
+    }
+}
+
+export class PlayerEffect {
+    /**
+     * The ID of the effect.
+     */
+    effectId: number;
+    /**
+     * If applicable, the duration of the effect.
+     */
+    duration?: number;
+    /**
+     * If applicable, the strength of the effect. (For example speed or multi jump effect)
+     */
+    strength?: number;
+    /**
+     * The time the effect occurred.
+     */
+    triggeredAt: number;
+
+    constructor(effect: IPlayerEffect, triggeredAt?: number) {
+        this.effectId = effect.effectId;
+        this.duration = effect.duration;
+        this.strength = effect.strength;
+
+        this.triggeredAt = triggeredAt ?? Date.now();
+    }
+
+
+    /**
+     * Note: If this effect is non timed, this will always return false.
+     */
+    get hasExpired() {
+        if (this.duration === undefined) return false;
+
+        return Date.now() > (this.triggeredAt + this.duration);
+    }
+
+    /**
+     * Milliseconds showing how long before this expires.
+     * 
+     * Note: If this effect is non timed, this will return infinity.
+     */
+    get remaining() {
+        if (this.duration === undefined) return Infinity;
+
+        return Math.max(0, Date.now() - (this.triggeredAt + this.duration));
+    }
+}

package/lib/index.ts

@@ -0,0 +1,8 @@
+export type * from "./types/index.d.ts";
+export { default as PWGameWorldHelper } from "./Helper.js";
+
+export { ComponentTypeHeader, default as BufferReader } from "./BufferReader.js";
+
+export { default as Block, BlockArgsHeadings } from "./Block.js";
+
+// import * from "./Helper";

package/lib/types/index.d.ts

@@ -0,0 +1,19 @@
+// I cba so all of the typings will go here
+
+type Point = { x: number, y: number };
+
+export interface SendableBlockPacket {
+    /**
+     * If true, just leave one position
+     */
+    isFillOperation: boolean;
+    blockId: number;
+    layer: number;
+    /**
+     * Note: (I THINK) 250 positions limit.
+     */
+    positions: Point[];
+    extraFields?: Uint8Array;
+}
+
+export type BlockArg = (string | number | bigint | boolean | Buffer);

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "pw-js-world",
+  "version": "0.0.1",
+  "description": "An optional package for PW-JS-Api, aims to serve world purposes.",
+  "main": "lib/index.ts",
+  "exports": {
+    "bun": "./dist/index.js",
+    "import": "./esm.mjs",
+    "require": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "keywords": [
+    "PixelWalker",
+    "Util",
+    "Utilities",
+    "Misc"
+  ],
+  "author": "Doomester",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doomestee/pw-js-world.git"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^22.10.5",
+    "ncp": "^2.0.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "tslib": "~2.8.1"
+  },
+  "peerDependencies": {
+    "pw-js-api": ">=0.2.1"
+  },
+  "scripts": {
+    "test": "bun test/index.ts",
+    "build": "rimraf dist && tsc -p tsconfig.json && ncp lib/types dist/types"
+  }
+}

package/test/index.ts

@@ -0,0 +1,96 @@
+import { LayerType } from "../lib/Constants";
+import { PWGameWorldHelper } from "../lib/index";
+import { BlockNames, PWApiClient } from "pw-js-api";
+
+const api = new PWApiClient("doomester@duck.com", "D!wr%Jy&z!uPSJ3m%5TG");
+const helper = new PWGameWorldHelper();
+
+await api.authenticate();
+
+const con = await api.joinWorld("rfdeeb8d9d94f76", {
+    gameSettings: {
+        handlePackets: ["PING", "INIT"]
+    }
+});
+
+con
+// .addHook<{ playerInitPacket: { def: string } }>(() => {})
+.addHook(helper.receiveHook)
+.addCallback("playerInitPacket", (data, states) => {
+    // console.log(states?.player?.isMe);
+
+    states?.player?.username
+
+    con.send("worldBlockPlacedPacket", 
+
+    helper.createBlockPacket(BlockNames.BASIC_GREEN, LayerType.Foreground, [{
+        x: 18,
+        y: 93
+    }, {
+        x: 19,
+        y: 94
+    }, {
+        x: 20,
+        y: 95
+    }]));
+
+    const signPack = helper.createBlockPacket(BlockNames.SIGN_BLUE, LayerType.Foreground, {
+        x: 19,
+        y: 98
+    }, new Date().toString());
+
+    console.log(signPack);
+    con.send("worldBlockPlacedPacket", signPack);
+
+    // console.log(data.globalSwitchState);
+})
+.addCallback("debug", egg => {
+    if (!egg.includes("ping")) console.log(egg)
+})
+
+.addCallback("worldBlockPlacedPacket", (data, states) => {
+    console.log("Prev Block Id: " + states?.oldBlocks[0].bId);
+    console.log("Prev Block Args: " + states?.oldBlocks[0].args);
+    console.log("New Block Id: " + states?.newBlocks[0].bId);
+    console.log("New Block Args: " + states?.newBlocks[0].args);
+})
+.addCallback("playerChatPacket", (data, states) => {
+    const msg = data.message;
+    const args = msg.split(" ");
+
+    switch (args[0]) {
+        case "!at":
+            if (args.length > 2) {
+                const nums = [parseInt(args[1]), parseInt(args[2])];
+
+                if (!nums.some(v => isNaN(v))) {
+                    const block = helper.getBlockAt(nums[0], nums[1], 1);
+
+                    return con.send("playerChatPacket", {
+                        message: "Block at (X: " + nums[0] + ", Y: " + nums[1] + ") - " + block.name + " (ID: " + block.bId + ", Args: " + block.hasArgs() + ")"
+                    })
+                }
+            }
+            break;
+        case "stat":
+            {
+                const player = states?.player;
+
+                console.log({
+                    isMe: player?.isMe,
+                    id: player?.playerId,
+                    effects: player?.effects,
+                    face: player?.face,
+                    states: {
+                        coins: [player?.states.coinsGold, player?.states.coinsBlue],
+                        deaths: player?.states.deaths,
+                        collected: player?.states.collectedItems.length,
+                        modes: [player?.states.godmode, player?.states.modmode],
+                        teamId: player?.states.teamId
+                    },
+                    name: player?.username
+                });
+            }
+            break;
+    }
+})