pw-js-api 0.2.2 → 0.2.3-dev.bf21f34

package/examples/index.mjs

@@ -0,0 +1,118 @@
+// Up to date as of v0.0.5
+// - 2025-01-01 21:37 UTC+0
+
+import { PWApiClient } from "pw-js-api";
+import { swapObject } from "./util.mjs";
+
+import { setTimeout } from "node:timers/promises";
+
+const cli = new PWApiClient("<YOUR EMAIL HERE>", "<YOUR PASSWORD HERE>");
+
+const mappings = await cli.getMappings();
+const blockIdToType = swapObject(mappings);
+
+// To fetch the token, allowing it to join a world.
+await cli.authenticate();
+
+const con = await cli.joinWorld("rfdeeb8d9d94f76", {
+    gameSettings: {
+        handlePackets: ["PING"]
+    }
+});
+
+/**
+ * Doesn't support filling
+ * @param {string} blockId 
+ * @param {{ x: number, y: number }[]} positions 
+ * @param {0|1} layer 
+ * @returns 
+ */
+const place = (blockId, positions, layer = 1) => {
+    return con.send("worldBlockPlacedPacket", {
+        blockId: mappings[blockId], layer,
+        positions, isFillOperation: false
+    });
+}
+
+let botId = 1; let isOwner = false;
+
+// You can use setCallBack (which returns itself for chaining)
+con.addCallback("playerInitPacket", (data) => {
+    console.log("Connected as " + data.playerProperties?.username);
+
+    if (data.playerProperties) {
+        botId = data.playerProperties.playerId;
+        isOwner = data.playerProperties.isWorldOwner;
+    }
+
+    con.send("playerInitReceived");
+}).addCallback("playerJoinedPacket", (data) => {
+    console.log(data.properties?.username + (data.properties.playerId < botId ? " is here." : " joined the world."));
+});
+
+con.addCallback("debug", console.log);
+
+const snakeable = ["basic_", "brick_", "beveled_", "glass_", "minerals_"];
+
+con.addCallback("worldBlockPlacedPacket", async function (data) {
+    if (data.playerId === botId) return;
+
+    if (isOwner) {
+        const blockId = blockIdToType[data.blockId];
+
+        if (data.isFillOperation) return; // fills have long cooldown.
+
+        if (snakeable.some(v => blockId === v + "green" || blockId === v + "red")) {
+            if (blockId.endsWith("green")) {
+                await setTimeout(150).then(() => place(blockId.split("_")[0] + "_red", data.positions, 1));
+            }
+            await setTimeout(300).then(() => place("empty", data.positions, 1));
+        }
+    }
+});
+
+let helpTime = -1;
+
+con.addCallback("systemMessagePacket", (data) => {
+    // From /help - continuation of .ping
+    if (data.message.startsWith("Available commands:")) {
+        con.send("playerChatPacket", {
+            message: "Pong! Response time: " + (Date.now() - helpTime) + "ms.",
+        });
+    }
+});
+
+// A con accepts multiple callbacks for the same type!
+// If one of the callback returns a "STOP" (similar to your typical event's stop propagation). It can even return a promise resolving to STOP too.
+
+// For example:
+// All messages will get logged if and only if the person isn't the bot.
+// This can be tested with the ".say .ping" command where you will notice that the bot's messages does not get logged nor will it be listened to.
+con.addCallback("playerChatPacket", (data) => {
+    if (data.playerId === botId) return "STOP";
+
+    console.log(data.message);
+});
+
+con.addCallback("playerChatPacket", (data) => {
+    const args = data.message.split(" ");
+    
+    switch (args[0].toLowerCase()) {
+        case ".ping":
+            helpTime = Date.now();
+            con.send("playerChatPacket", {
+                message: "/help"
+            });
+            break;
+        case ".disconnect":
+            if (args[1] === "-f") con.settings.reconnectable = false;
+
+            con.socket?.close();
+            break;
+        case ".say":
+            con.send("playerChatPacket", {
+                message: args.slice(1).join(" ")
+            });
+            break;
+    }
+});

package/examples/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "pw-snake-js-bot",
+  "version": "0.0.1",
+  "description": "An example bot that does simple snake and ping command",
+  "main": "./index.js",
+  "scripts": {
+    "start": "node ./index.js"
+  },
+  "keywords": ["PixelWalker", "Example"],
+  "author": "Doomester",
+  "license": "Unlicense",
+  "type": "module",
+  "dependencies": {
+    "pw-js-api": "^0.0.5"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.3"
+  }
+}

package/examples/util.mjs

@@ -0,0 +1,24 @@
+/**
+ * Converted from typescript.
+ * @template {string} K
+ * @template {string|number} [Y=string]
+ * 
+ * @param {Record<K, Y>} obj 
+ */
+export function swapObject(obj) {
+    /**
+     * @type {Record<Y, K>}
+     */
+    const res = {};
+
+    /**
+     * @type {[Y, string][]}
+     */
+    const entries = Object.entries(obj);
+
+    for (let i = 0, len = entries.len; i < len; i++) {
+        res[entries[i][1]] = entries[i][0];
+    }
+
+    return res;
+}

package/input/world.proto

@@ -0,0 +1,381 @@
+syntax = "proto3";
+package WorldPackets;
+
+option csharp_namespace = "PixelWalker.Networking.Protobuf.WorldPackets";
+
+
+message WorldPacket {
+    oneof packet {
+        /* Ping packet */
+        Ping ping = 1;
+
+        /* On join */
+        PlayerInitPacket player_init_packet = 2;
+        PlayerInitReceivedPacket player_init_received = 3;
+
+        /* Player packets - Send/received while playing */
+        PlayerJoinedPacket player_joined_packet = 4;
+        PlayerLeftPacket player_left_packet = 5;
+        PlayerChatPacket player_chat_packet = 6;
+        PlayerUpdateRightsPacket player_update_rights_packet = 7;
+        PlayerMovedPacket player_moved_packet = 8;
+        PlayerFacePacket player_face_packet = 9;
+        PlayerGodModePacket player_god_mode_packet = 10;
+        PlayerModModePacket player_mod_mode_packet = 11;
+        PlayerRespawnPacket player_respawn_packet = 12;
+        PlayerResetPacket player_reset_packet = 13;
+        PlayerTouchBlockPacket player_touch_block_packet = 14;
+        PlayerAddEffectPacket player_add_effect_packet = 15;
+        PlayerRemoveEffectPacket player_remove_effect_packet = 16;
+        PlayerResetEffectsPacket player_reset_effects_packet = 17;
+        PlayerTeamUpdatePacket player_team_update_packet = 18;
+        PlayerCountersUpdatePacket player_counters_update_packet = 19;
+        PlayerLocalSwitchChangedPacket player_local_switch_changed_packet = 20;
+        PlayerLocalSwitchResetPacket player_local_switch_reset_packet = 21;
+        PlayerDirectMessagePacket player_direct_message_packet = 22;
+        PlayerTouchPlayerPacket player_touch_player_packet = 23;
+        PlayerTeleportedPacket player_teleported_packet = 24;
+
+        /* World packets - Mostly send out by the server */
+        WorldReloadedPacket world_reloaded_packet = 25;
+        WorldClearedPacket world_cleared_packet = 26;
+        WorldMetaUpdatePacket world_meta_update_packet = 27;
+        WorldBlockPlacedPacket world_block_placed_packet = 28;
+        WorldBlockFilledPacket world_block_filled_packet = 29;
+
+        /* MISC */
+        OldChatMessagesPacket old_chat_messages_packet = 30;
+        SystemMessagePacket system_message_packet = 31;
+        
+        GlobalSwitchChangedPacket global_switch_changed_packet = 32;
+        GlobalSwitchResetPacket global_switch_reset_packet = 33;
+
+        PerformWorldActionPacket perform_world_action_packet = 34;
+
+        PlayerSpectatePacket player_spectate_packet = 35;
+    }
+}
+
+message Ping {
+    /* Empty */
+}
+
+/*
+ * Misc PACKETS
+ */
+message GlobalSwitchChangedPacket {
+    int32 player_id = 1;
+    int32 switch_id = 2;
+    bool enabled = 3;
+}
+
+message GlobalSwitchResetPacket {
+    int32 player_id = 1;
+    bool enabled = 2;
+}
+
+message SystemMessagePacket {
+    string title = 1;
+    string message = 2;
+    bool is_dialog = 3;
+}
+
+message OldChatMessagesPacket {
+    repeated OldChatMessage old_chat_messages = 1;
+}
+
+message PerformWorldActionPacket {
+    enum Action {
+        SAVE_WORLD = 0;
+        RELOAD_WORLD = 1;
+        CLEAR_WORLD = 3;
+    }
+
+    Action action = 1;
+}
+
+/*
+ * World PACKETS
+ */
+message WorldReloadedPacket {
+    bytes world_data = 1;
+}
+
+message WorldClearedPacket {
+    /* Empty */
+}
+
+message WorldBlockPlacedPacket {
+    optional int32 player_id = 1;
+    
+    bool is_fill_operation = 3;
+    
+    // Repeated for use in fill operations
+    repeated PointInteger positions = 4;
+    int32 layer = 5;
+    int32 block_id = 6;
+
+    // Legacy? Holds a byte[] that can hold extra information
+    bytes extra_fields = 7;
+}
+
+message WorldBlockFilledPacket {
+    PointInteger position = 1;
+    bool ignoreLayers = 2;
+    int32 layer = 3;
+    int32 block_id = 4;
+
+    // Legacy? Holds a byte[] that can hold extra information
+    bytes extra_fields = 5;
+}
+
+message WorldMetaUpdatePacket {
+    WorldMeta meta = 1;
+}
+
+
+/*
+ * PLAYER PACKETS
+ */
+message PlayerInitPacket {
+    /* player_id located in PlayerProperties */
+    PlayerProperties player_properties = 1;
+    WorldMeta world_meta = 2;
+
+    /* Static world information */
+    int32 world_width = 3;
+    int32 world_height = 4;
+
+    /* Very specific world state */
+    bytes global_switch_state = 6;
+    bytes world_data = 7;
+}
+
+message PlayerInitReceivedPacket {
+    /* Pong back to the server that init has been done. */
+}
+
+message PlayerJoinedPacket {
+  PlayerProperties properties = 1;
+  PlayerWorldState world_state = 2;
+}
+
+message PlayerLeftPacket {
+    /* No content required */
+    int32 player_id = 1;
+}
+
+message PlayerChatPacket {
+    int32 player_id = 1;
+    string message = 2;
+}
+
+message PlayerUpdateRightsPacket {
+    optional int32 player_id = 1;
+    PlayerRights rights = 2;
+}
+
+message PlayerMovedPacket {
+    optional int32 player_id = 1;
+    
+    PointDouble position = 2;
+    double velocity_x = 3;
+    double velocity_y = 4;
+    double modifier_x = 5;
+    double modifier_y = 6;
+    int32 horizontal = 7;
+    int32 vertical = 8;
+
+    bool space_down = 9;
+    bool space_just_down = 10;
+    bool just_teleported = 11;
+
+    int32 tick_id = 12;
+}
+
+message PlayerTeleportedPacket {
+    optional int32 player_id = 1;
+    PointDouble position = 2;
+}
+
+message PlayerFacePacket {
+    optional int32 player_id = 1;
+    int32 face_id = 2;
+}
+
+message PlayerSpectatePacket {
+    optional int32 player_id = 1;
+    int32 spectate_player = 2;
+}
+
+message PlayerGodModePacket {
+    optional int32 player_id = 1;
+    bool enabled = 2;
+}
+
+message PlayerModModePacket {
+    optional int32 player_id = 1;
+    bool enabled = 3;
+}
+
+message PlayerRespawnPacket {
+    optional int32 player_id = 1;
+    PointInteger position = 2;
+}
+
+message PlayerResetPacket {
+    optional int32 player_id = 1;
+    optional PointInteger position = 2;
+}
+
+message PlayerTouchBlockPacket {
+    optional int32 player_id = 1;
+    optional PointInteger position = 2;
+    int32 block_id = 3;
+}
+
+message PlayerTouchPlayerPacket {
+    optional int32 player_id = 1;
+    int32 touched_player = 2;
+    TouchType touch_type = 3;
+
+    enum TouchType {
+        START = 0;
+        END = 1;
+    }
+}
+
+message PlayerAddEffectPacket {
+    optional int32 player_id = 1;
+    bool from_server = 2;
+
+    /* Effect data */
+    int32 effect_id = 3; // Todo: Make this an enum.
+
+    optional int32 duration = 4;
+    optional int32 strength = 5;
+}
+
+message PlayerRemoveEffectPacket {
+    optional int32 player_id = 1;
+
+    int32 effect_id = 4; // Todo: Make this an enum.
+}
+
+message PlayerResetEffectsPacket {
+    optional int32 player_id = 1;
+    bool from_server = 2;
+}
+
+message PlayerTeamUpdatePacket {
+    optional int32 player_id = 1;
+    int32 team_id = 2;
+}
+
+message PlayerCountersUpdatePacket {
+    optional int32 player_id = 1;
+
+    int32 coins = 2;
+    int32 blue_coins = 3;
+    int32 deaths = 4;
+}
+
+message PlayerLocalSwitchChangedPacket {
+    optional int32 player_id = 1;
+    int32 switch_id = 2;
+    bool switch_enabled = 3;
+}
+
+message PlayerLocalSwitchResetPacket {
+    optional int32 player_id = 1;
+    int32 switch_id = 2;
+    bool switch_enabled = 3;
+}
+
+message PlayerDirectMessagePacket {
+    int32 from_player_id = 1;
+    int32 target_player_id = 2;
+
+    string message = 3;
+}
+
+/*
+     ============================================
+            PARTS, not messages themselves.
+     ============================================
+ */
+message PlayerWorldState {
+    int32 coins_gold = 1;
+    int32 coins_blue = 2;
+    int32 deaths = 3;
+    repeated PointInteger collected_items = 4;
+    bool has_gold_crown = 5;
+    bool has_silver_crown = 6;
+    bytes switches = 7;
+    bool godmode = 8;
+    bool modmode = 9;
+    int32 team_id = 10;
+}
+
+message PlayerProperties {
+    int32 player_id = 1;
+    string account_id = 2;
+    string username = 3;
+    int32 face = 4;
+    string role = 5;
+    bool is_friend = 6;
+    PointDouble position = 7;
+    bool is_world_owner = 8;
+    PlayerRights rights = 9;
+}
+
+message PlayerRights {
+    bool can_edit = 1;
+    bool can_god = 2;
+    bool can_toggle_minimap = 3;
+    bool can_change_world_settings = 4;
+
+    repeated string available_commands = 5;
+}
+
+message WorldMeta {
+    string title = 1;
+    int32 plays = 2;
+    string owner = 3;
+    string description = 4;
+    string visibility = 5;
+    WorldType world_Type = 6;
+    bool has_unsaved_changes = 7;
+    int32 max_players = 8;
+    string owner_role = 9;
+    bool minimap_enabled = 10;
+    
+    enum WorldType {
+        Saved = 0;
+        Unsaved = 1;
+        Legacy = 2;
+    }
+}
+
+message OldChatMessage {
+    string player_name = 1;
+    string player_role = 2;
+    bool is_friend = 3;
+    string message = 4;
+}
+
+/*
+ * Represents an integer position.
+ */
+message PointInteger {
+    int32 x = 1;
+    int32 y = 2;
+}
+
+/*
+ * Represents a double position.
+ */
+message PointDouble {
+    double x = 1;
+    double y = 2;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pw-js-api",
-  "version": "0.2.2",
+  "version": "0.2.3-dev.bf21f34",
   "description": "A PixelWalker Library, aims to be minimal with support for browsers.",
   "exports": {
     "types": "./esm/index.js",