yolkbot 0.1.0-alpha.5 → 0.1.0-alpha.7

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "yolkbot",
     "description": "create a shell shockers (self) bot in under 10 lines.",
-    "version": "0.1.0-alpha.5",
+    "version": "0.1.0-alpha.7",
     "keywords": [
         "shell shockers",
         "shellshock.io",
@@ -49,9 +49,18 @@
         "./constants": "./src/constants/index.js",
         "./constants/*": "./src/constants/*.js",
         "./constants/*.js": "./src/constants/*.js",
-        "./dispatch": "./src/dispatches/index.js",
-        "./dispatch/*": "./src/dispatches/*.js",
-        "./dispatch/*.js": "./src/dispatches/*.js"
+        "./dispatch": {
+            "import": "./src/dispatches/index.js",
+            "types": "./src/types/dispatches.d.ts"
+        },
+        "./dispatch/*": {
+            "import": "./src/dispatches/*.js",
+            "types": "./src/types/dispatches/*.d.ts"
+        },
+        "./dispatch/*.js": {
+            "import": "./src/dispatches/*.js",
+            "types": "./src/types/dispatches/*.d.ts"
+        }
     },
     "dependencies": {
         "socks-proxy-agent": "^8.0.5",

package/src/dispatches/index.js

@@ -15,6 +15,7 @@ import SaveLoadoutDispatch from './SaveLoadoutDispatch.js';
 import SpawnDispatch from './SpawnDispatch.js';
 import SwapWeaponDispatch from './SwapWeaponDispatch.js';
 import SwitchTeamDispatch from './SwitchTeamDispatch.js';
+import ThrowGrenadeDispatch from './ThrowGrenadeDispatch.js';
 
 export {
     BootPlayerDispatch,
@@ -33,7 +34,8 @@ export {
     SaveLoadoutDispatch,
     SpawnDispatch,
     SwapWeaponDispatch,
-    SwitchTeamDispatch
+    SwitchTeamDispatch,
+    ThrowGrenadeDispatch
 }
 
 export default {
@@ -53,5 +55,6 @@ export default {
     SaveLoadoutDispatch,
     SpawnDispatch,
     SwapWeaponDispatch,
-    SwitchTeamDispatch
+    SwitchTeamDispatch,
+    ThrowGrenadeDispatch
 }

package/src/types/bot/GamePlayer.d.ts

@@ -0,0 +1,83 @@
+import { GunList } from '#constants';
+import { Cluck9mm } from '../constants/guns.js';
+
+export interface Position {
+    x: number;
+    y: number;
+    z: number;
+}
+
+export interface View {
+    yaw: number;
+    pitch: number;
+}
+
+export interface Character {
+    eggColor: string;
+    primaryGun: any;
+    secondaryGun: any;
+    stamp: any;
+    hat: any;
+    grenade: any;
+    melee: any;
+}
+
+export interface Buffer {
+    [key: number]: any;
+}
+
+export interface PlayerData {
+    name_: string;
+    uniqueId_: string;
+    playing_: boolean;
+    social_: string;
+    hideBadge_: boolean;
+    x_: number;
+    y_: number;
+    z_: number;
+    yaw_: number;
+    pitch_: number;
+    shellColor_: string;
+    primaryWeaponItem_: any;
+    secondaryWeaponItem_: any;
+    stampItem_: any;
+    hatItem_: any;
+    grenadeItem_: any;
+    meleeItem_: any;
+    weaponIdx_: number;
+}
+
+export class GamePlayer {
+    id: string;
+    team: string;
+    data: PlayerData;
+    name: string;
+    uniqueId: string;
+    playing: boolean;
+    social: any;
+    showBadge: boolean;
+    position: Position;
+    jumping: boolean;
+    climbing: boolean;
+    view: View;
+    character: Character;
+    activeGun: number;
+    selectedGun: number;
+    weapons: any[];
+    grenades: number;
+    buffer: Buffer;
+    kills: number;
+    hp: number;
+    hpShield: number;
+    streakRewards: any[];
+    randomSeed: number;
+    serverStateIdx: number;
+
+    constructor(id: string, team: string, playerData: PlayerData);
+
+    dispatch(): void;
+    join(): void;
+    update(): void;
+}
+
+export default GamePlayer;

package/src/types/bot.d.ts

@@ -1,10 +1,11 @@
 import { CommCode } from '../comm/Codes.js';
-import { GamePlayer } from '../bot/GamePlayer.js';
 import { Matchmaker } from '../matchmaker.js';
 import { yolkws } from '../socket.js';
 import { NodeList } from '../pathing/mapnode.js';
 import { Maps } from '../constants/maps.js';
 
+import { GamePlayer } from './bot/GamePlayer.js';
+
 export interface BotParams {
     name?: string;
     proxy?: string;
@@ -51,8 +52,32 @@ export interface GameOptions {
     mustUseSecondary: boolean;
 }
 
+export interface RawGameData {
+    command: 'gameFound';
+    region: string;
+    subdomain: string;
+    id: string;
+    uuid: string;
+    private: boolean;
+    noobLobby: boolean;
+}
+
+export interface RawMapData {
+    filename: string;
+    hash: string;
+    name: string;
+    modes: {
+        FFA: boolean;
+        Teams: boolean;
+        Spatula: boolean;
+        King?: boolean;
+    };
+    availability: string;
+    numPlayers: string;
+}
+
 export interface Game {
-    raw: any;
+    raw: RawGameData;
     code: string;
     gameModeId: number;
     gameMode: string;
@@ -69,7 +94,7 @@ export interface Game {
         };
         availability: string;
         numPlayers: string;
-        raw: any;
+        raw: RawMapData;
         nodes: any;
     };
     playerLimit: number;
@@ -119,16 +144,11 @@ export class Bot {
     pingInterval: number;
     updateInterval: number;
     instance: string;
-    _hooks: Record<string, Function[]>;
-    _globalHooks: Function[];
-    _liveCallbacks: Function[];
     state: BotState;
     players: Record<string, GamePlayer>;
     me: GamePlayer;
     game: Game;
     account: Account;
-    _dispatches: any[];
-    _packetQueue: any[];
     gameSocket: yolkws | null;
     ping: number;
     lastPingTime: number;
@@ -147,8 +167,8 @@ export class Bot {
     dispatch(disp: any): void;
     drain(): void;
     initMatchmaker(): Promise<boolean>;
-    createPrivateGame(opts: { region: string; mode: string; map: string }): Promise<any>;
-    join(data: string | any): Promise<void>;
+    createPrivateGame(opts: { region: string; mode: string; map: string }): Promise<RawGameData>;
+    join(data: string | RawGameData): Promise<void>;
     update(): void;
     on(event: string, cb: Function): void;
     onAny(cb: Function): void;

package/src/types/dispatches/BootPlayerDispatch.d.ts

@@ -0,0 +1,10 @@
+export declare class BootPlayerDispatch {
+    uniqueId: string;
+
+    constructor(uniqueId: string);
+
+    check(bot: any): boolean;
+    execute(bot: any): void;
+}
+
+export default BootPlayerDispatch;

package/src/types/dispatches/ChatDispatch.d.ts

@@ -0,0 +1,10 @@
+import packet from '#packet';
+
+export declare class ChatDispatch {
+    constructor(msg: string, noLimit?: boolean);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ChatDispatch;

package/src/types/dispatches/FireDispatch.d.ts

@@ -0,0 +1,8 @@
+export declare class FireDispatch {
+    constructor(amount: number);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default FireDispatch;

package/src/types/dispatches/GameOptionsDispatch.d.ts

@@ -0,0 +1,8 @@
+import packet from '#packet';
+
+export declare class GameOptionsDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default GameOptionsDispatch;

package/src/types/dispatches/GoToPlayerDispatch.d.ts

@@ -0,0 +1,10 @@
+import AStar from '../pathing/astar.js';
+
+export declare class GoToPlayerDispatch {
+    constructor(target: GamePlayer);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default GoToPlayerDispatch;

package/src/types/dispatches/GoToSpatulaDispatch.d.ts

@@ -0,0 +1,8 @@
+import AStar from '../pathing/astar.js';
+
+export class GoToSpatulaDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default GoToSpatulaDispatch;

package/src/types/dispatches/LookAtDispatch.d.ts

@@ -0,0 +1,14 @@
+import Bot from '../bot';
+
+declare class LookAtDispatch {
+    idOrName: number | string;
+    id?: number;
+    name?: string;
+
+    constructor(idOrName: number | string);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default LookAtDispatch;

package/src/types/dispatches/LookAtPosDispatch.d.ts

@@ -0,0 +1,17 @@
+type Position = {
+    x: number;
+    y: number;
+    z: number;
+}
+
+export declare class LookAtPosDispatch {
+    idOrName: any;
+    pos: Position;
+
+    constructor(pos: Position);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default LookAtPosDispatch;

package/src/types/dispatches/MeleeDispatch.d.ts

@@ -0,0 +1,6 @@
+export class MeleeDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default MeleeDispatch;

package/src/types/dispatches/MovementDispatch.d.ts

@@ -0,0 +1,10 @@
+export class MovementDispatch {
+    controlKeys: number;
+
+    constructor(controlKeys: number | number[]);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default MovementDispatch;

package/src/types/dispatches/PauseDispatch.d.ts

@@ -0,0 +1,6 @@
+export class PauseDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default PauseDispatch;

package/src/types/dispatches/ReloadDispatch.d.ts

@@ -0,0 +1,6 @@
+export class ReloadDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ReloadDispatch;

package/src/types/dispatches/ReportPlayerDispatch.d.ts

@@ -0,0 +1,13 @@
+export class ReportPlayerDispatch {
+    id?: number;
+    name?: string;
+    reasons: boolean[];
+    reasonInt: number;
+
+    constructor(idOrName: number | string, reasons?: { cheating?: boolean; harassment?: boolean; offensive?: boolean; other?: boolean });
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ReportPlayerDispatch;

package/src/types/dispatches/SaveLoadoutDispatch.d.ts

@@ -0,0 +1,32 @@
+type Changes = {
+    classIdx?: number;
+    hatId?: number;
+    stampId?: number;
+    grenadeId?: number;
+    meleeId?: number;
+    colorIdx?: number;
+    primaryId?: number[];
+    secondaryId?: number[];
+}
+
+type Opts = {
+    gunId?: number;
+    hatId?: number;
+    stampId?: number;
+    grenadeId?: number;
+    meleeId?: number;
+    eggColor?: number;
+    primaryIds?: number[];
+    secondaryIds?: number[];
+}
+
+export class SaveLoadoutDispatch {
+    changes: Changes;
+
+    constructor(opts: Opts);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SaveLoadoutDispatch;

package/src/types/dispatches/SpawnDispatch.d.ts

@@ -0,0 +1,6 @@
+export class SpawnDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SpawnDispatch;

package/src/types/dispatches/SwapWeaponDispatch.d.ts

@@ -0,0 +1,6 @@
+export class SwapWeaponDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SwapWeaponDispatch;

package/src/types/dispatches/SwitchTeamDispatch.d.ts

@@ -0,0 +1,6 @@
+export class SwitchTeamDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SwitchTeamDispatch;

package/src/types/dispatches/ThrowGrenadeDispatch.d.ts

@@ -0,0 +1,7 @@
+export class ThrowGrenadeDispatch {
+    constructor(power?: number);
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ThrowGrenadeDispatch;

package/src/types/dispatches/index.d.ts

@@ -0,0 +1,130 @@
+import BootPlayerDispatch from './BootPlayerDispatch';
+import ChatDispatch from './ChatDispatch';
+import FireDispatch from './FireDispatch';
+import GameOptionsDispatch from './GameOptionsDispatch';
+import GoToPlayerDispatch from './GoToPlayerDispatch';
+import GoToSpatulaDispatch from './GoToSpatulaDispatch';
+import LookAtDispatch from './LookAtDispatch';
+import LookAtPosDispatch from './LookAtPosDispatch';
+import MeleeDispatch from './MeleeDispatch';
+import MovementDispatch from './MovementDispatch';
+import PauseDispatch from './PauseDispatch';
+import ReloadDispatch from './ReloadDispatch';
+import ReportPlayerDispatch from './ReportPlayerDispatch';
+import SaveLoadoutDispatch from './SaveLoadoutDispatch';
+import SpawnDispatch from './SpawnDispatch';
+import SwapWeaponDispatch from './SwapWeaponDispatch';
+import SwitchTeamDispatch from './SwitchTeamDispatch';
+import ThrowGrenadeDispatch from './ThrowGrenadeDispatch';
+
+declare module 'BootPlayerDispatch' {
+    export default BootPlayerDispatch;
+}
+
+declare module 'ChatDispatch' {
+    export default ChatDispatch;
+}
+
+declare module 'FireDispatch' {
+    export default FireDispatch;
+}
+
+declare module 'GameOptionsDispatch' {
+    export default GameOptionsDispatch;
+}
+
+declare module 'GoToPlayerDispatch' {
+    export default GoToPlayerDispatch;
+}
+
+declare module 'GoToSpatulaDispatch' {
+    export default GoToSpatulaDispatch;
+}
+
+declare module 'LookAtDispatch' {
+    export default LookAtDispatch;
+}
+
+declare module 'LookAtPosDispatch' {
+    export default LookAtPosDispatch;
+}
+
+declare module 'MeleeDispatch' {
+    export default MeleeDispatch;
+}
+
+declare module 'MovementDispatch' {
+    export default MovementDispatch;
+}
+
+declare module 'PauseDispatch' {
+    export default PauseDispatch;
+}
+
+declare module 'ReloadDispatch' {
+    export default ReloadDispatch;
+}
+
+declare module 'ReportPlayerDispatch' {
+    export default ReportPlayerDispatch;
+}
+
+declare module 'SaveLoadoutDispatch' {
+    export default SaveLoadoutDispatch;
+}
+
+declare module 'SpawnDispatch' {
+    export default SpawnDispatch;
+}
+
+declare module 'SwapWeaponDispatch' {
+    export default SwapWeaponDispatch;
+}
+
+declare module 'SwitchTeamDispatch' {
+    export default SwitchTeamDispatch;
+}
+
+declare module 'dispatches' {
+    export {
+        BootPlayerDispatch,
+        ChatDispatch,
+        FireDispatch,
+        GameOptionsDispatch,
+        GoToPlayerDispatch,
+        GoToSpatulaDispatch,
+        LookAtDispatch,
+        LookAtPosDispatch,
+        MeleeDispatch,
+        MovementDispatch,
+        PauseDispatch,
+        ReloadDispatch,
+        ReportPlayerDispatch,
+        SaveLoadoutDispatch,
+        SpawnDispatch,
+        SwapWeaponDispatch,
+        SwitchTeamDispatch
+    }
+
+    const dispatches: {
+        BootPlayerDispatch: typeof BootPlayerDispatch,
+        ChatDispatch: typeof ChatDispatch,
+        FireDispatch: typeof FireDispatch,
+        GameOptionsDispatch: typeof GameOptionsDispatch,
+        GoToPlayerDispatch: typeof GoToPlayerDispatch,
+        GoToSpatulaDispatch: typeof GoToSpatulaDispatch,
+        LookAtDispatch: typeof LookAtDispatch,
+        LookAtPosDispatch: typeof LookAtPosDispatch,
+        MeleeDispatch: typeof MeleeDispatch,
+        MovementDispatch: typeof MovementDispatch,
+        PauseDispatch: typeof PauseDispatch,
+        ReloadDispatch: typeof ReloadDispatch,
+        ReportPlayerDispatch: typeof ReportPlayerDispatch,
+        SaveLoadoutDispatch: typeof SaveLoadoutDispatch,
+        SpawnDispatch: typeof SpawnDispatch,
+        SwapWeaponDispatch: typeof SwapWeaponDispatch,
+        SwitchTeamDispatch: typeof SwitchTeamDispatch
+    };
+
+    export default dispatches;
+}