yolkbot 0.1.0-alpha.9 → 0.1.1-alpha.10

package/src/types/bot.d.ts

@@ -1,25 +1,72 @@
 import { NodeList } from '../pathing/mapnode.js';
-import { yolkws } from '../socket.js';
 
 import { Character, GamePlayer } from './bot/GamePlayer';
-import { Gun } from './gun';
-import { Matchmaker } from './matchmaker';
+import { Challenge } from './constants/challenges';
+import { AnyGun } from './constants/guns';
+import { Map } from './constants/maps';
+import { ADispatch } from './dispatches/index';
+import { Matchmaker, RawGameData } from './matchmaker';
+import yolkws from './socket';
 
 export interface BotParams {
-    name?: string;
-    proxy?: string;
+    intents?: number[];
     doUpdate?: boolean;
     updateInterval?: number;
-    doPing?: boolean;
-    pingInterval?: number;
-    doPathing?: boolean;
+    proxy?: string;
     instance?: string;
 }
 
+export interface ChiknWinnerStatus {
+    atLimit: boolean;
+    limit: number;
+    secondsUntilPlay: number;
+    canPlayAgain: number;
+}
+
+export interface StatKD {
+    total: number;
+    mode: {
+        public: number;
+        private: number;
+    };
+    dmgType: {
+        pistol: number;
+        grenade: number;
+        rpegg: number;
+        eggk: number;
+        scrambler: number;
+        ranger: number;
+        whpper: number;
+        crackshot: number;
+        trihard: number;
+        melee: number;
+    };
+    gameType: {
+        kotc: number;
+        spatula: number;
+        ffa: number;
+        team: number;
+    }
+}
+
+export interface Stats {
+    streak: number;
+    kills: StatKD;
+    deaths: StatKD;
+    gameType: {
+        kotc: {
+            captured: number;
+            wins: number;
+        }
+    };
+}
+
 export interface Account {
+    id: number;
     firebaseId: string;
     sessionId: string;
     session: string;
+    cw: ChiknWinnerStatus;
     loadout: {
         hatId: number | null;
         meleeId: number;
@@ -37,7 +84,12 @@ export interface Account {
     accountAge: number;
     emailVerified: boolean;
     eggBalance: number;
-    rawLoginData: any;
+    stats: {
+        lifetime: Stats;
+        monthly: Stats;
+    }
+    challenges: Challenge[];
+    rawLoginData: any; // i ain't typing allat
 }
 
 export interface GameOptions {
@@ -51,30 +103,6 @@ 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 Collectable {
     id: number;
     x: number;
@@ -82,6 +110,13 @@ export interface Collectable {
     z: number;
 }
 
+export interface Zone {
+    x: number;
+    y: number;
+    z: number;
+    zone: number;
+}
+
 export interface Game {
     raw: RawGameData;
     code: string;
@@ -100,8 +135,8 @@ export interface Game {
         };
         availability: string;
         numPlayers: string;
-        raw: RawMapData;
-        nodes: any;
+        raw: Map;
+        zones: Zone[][];
     };
     playerLimit: number;
     isGameOwner: boolean;
@@ -115,12 +150,14 @@ export interface Game {
         controlledByTeam: number;
     };
     stage: number;
-    activeZone: number;
+    zoneNumber: number;
+    activeZone: Zone[];
     capturing: number;
     captureProgress: number;
     numCapturing: number;
     stageName: string;
     capturePercent: number;
+    socket: yolkws | null;
 }
 
 export interface Pathing {
@@ -132,22 +169,37 @@ export interface Pathing {
 }
 
 export interface BotState {
-    loggedIn: boolean;
-    gameFound: boolean;
+    name: string;
     reloading: boolean;
     swappingGun: boolean;
     usingMelee: boolean;
     shotsFired: number;
-    joinedGame?: boolean;
+}
+
+export interface ChiknWinnerResponse {
+    eggsGiven: number;
+    itemIds: number[];
+    rewardTier: number;
+}
+
+type intents = {
+    CHALLENGES: 1,
+    STATS: 2,
+    PATHFINDING: 3,
+    BUFFERS: 4,
+    PING: 5,
+    COSMETIC_DATA: 6,
+    PLAYER_HEALTH: 7,
+    PACKET_HOOK: 8
 }
 
 export class Bot {
+    static Intents: intents;
+    Intents: intents;
+
     proxy: string;
-    name: string;
-    autoPing: boolean;
     autoUpdate: boolean;
     disablePathing: boolean;
-    pingInterval: number;
     updateInterval: number;
     instance: string;
     state: BotState;
@@ -155,62 +207,81 @@ export class Bot {
     me: GamePlayer;
     game: Game;
     account: Account;
-    gameSocket: yolkws | null;
     ping: number;
     lastPingTime: number;
     lastDeathTime: number;
     lastChatTime: number;
     lastUpdateTime: number;
-    nUpdates: number;
     controlKeys: number;
-    initTime: number;
     pathing: Pathing;
     matchmaker: Matchmaker | null;
 
     constructor(params?: BotParams);
 
+    loginAnonymously(): Promise<Account | false>;
+    loginWithRefreshToken(refreshToken: string): Promise<Account | false>;
     login(email: string, pass: string): Promise<Account | false>;
-    dispatch(disp: any): void;
-    drain(): void;
+    createAccount(email: string, pass: string): Promise<Account | false>;
+
     initMatchmaker(): Promise<boolean>;
     createPrivateGame(opts: { region: string; mode: string; map: string }): Promise<RawGameData>;
-    join(data: string | RawGameData): Promise<void>;
+    join(botName: string, data: string | RawGameData): Promise<void>;
+
+    dispatch(disp: ADispatch): void;
     update(): void;
-    on(event: string, cb: Function): void;
+
+    canSee(player: GamePlayer): boolean;
+    getBestTarget(): GamePlayer | undefined;
+
     onAny(cb: Function): void;
-    
+
     on(event: 'authFail', cb: (reason: string) => void): void;
     on(event: 'balanceUpdate', cb: (oldBalance: number, newBalance: number) => void): void;
     on(event: 'banned', cb: (banRemaining: string) => void): void;
-    on(event: 'chat', cb: (player: GamePlayer, message: string, flags: number) => void): void;
+    on(event: 'chat', cb: (player: GamePlayer | undefined, message: string, flags: number) => void): void;
     on(event: 'close', cb: (code: number) => void): void;
-    on(event: 'collectAmmo', cb: (player: GamePlayer, weapon: Gun) => void): void;
+    on(event: 'collectAmmo', cb: (player: GamePlayer, weapon: AnyGun) => void): void;
     on(event: 'collectGrenade', cb: (player: GamePlayer) => void): void;
     on(event: 'gameForcePause', cb: () => void): void;
     on(event: 'gameOptionsChange', cb: (oldOptions: GameOptions, newOptions: GameOptions) => void): void;
     on(event: 'gameReset', cb: () => void): void;
     on(event: 'gameStateChange', cb: (oldState: Game, newState: Game) => void): void;
+    on(event: 'grenadeExploded', cb: (item: Item | number, pos: { x: number; y: number; z: number }, damage: number, radius: number) => void): void;
     on(event: 'pingUpdate', cb: (oldPing: number, newPing: number) => void): void;
     on(event: 'playerBeginStreak', cb: (player: GamePlayer, streak: number) => void): void;
     on(event: 'playerChangeCharacter', cb: (player: GamePlayer, oldCharacter: Character, newCharacter: Character) => void): void;
     on(event: 'playerChangeGun', cb: (player: GamePlayer, oldGun: number, newGun: number) => void): void;
     on(event: 'playerDamaged', cb: (player: GamePlayer, oldHp: number, newHp: number) => void): void;
     on(event: 'playerDeath', cb: (player: GamePlayer, killer: GamePlayer) => void): void;
-    on(event: 'playerFire', cb: (player: GamePlayer, weapon: Gun) => void): void;
+    on(event: 'playerFire', cb: (player: GamePlayer, weapon: AnyGun) => void): void;
     on(event: 'playerJoin', cb: (player: GamePlayer) => void): void;
     on(event: 'playerLeave', cb: (player: GamePlayer) => void): void;
     on(event: 'playerMelee', cb: (player: GamePlayer) => void): void;
     on(event: 'playerPause', cb: (player: GamePlayer) => void): void;
-    on(event: 'playerReload', cb: (player: GamePlayer, weapon: Gun) => void): void;
+    on(event: 'playerReload', cb: (player: GamePlayer, weapon: AnyGun) => void): void;
     on(event: 'playerRespawn', cb: (player: GamePlayer) => void): void;
     on(event: 'playerSwapWeapon', cb: (player: GamePlayer, nowActive: number) => void): void;
     on(event: 'playerSwitchTeam', cb: (player: GamePlayer, oldTeam: number, newTeam: number) => void): void;
+    on(event: 'rocketHit', cb: (pos: { x: number; y: number; z: number }, damage: number, radius: number) => void): void;
     on(event: 'selfDamaged', cb: (oldHp: number, newHp: number) => void): void;
     on(event: 'selfMoved', cb: (oldPos: { x: number; y: number; z: number }, newPos: { x: number; y: number; z: number }) => void): void;
     on(event: 'selfRespawnFail', cb: () => void): void;
     on(event: 'selfShieldHit', cb: (oldShield: number, newShield: number) => void): void;
     on(event: 'selfShieldLost', cb: () => void): void;
     on(event: 'spawnItem', cb: (type: number, _id: number, pos: { x: number; y: number; z: number }) => void): void;
+    on(event: 'tick', cb: () => void): void;
+
+    checkChiknWinner(): Promise<ChiknWinnerStatus>;
+    playChiknWinner(): Promise<ChiknWinnerResponse | string>;
+    resetChiknWinner(): Promise<ChiknWinnerStatus>;
+
+    refreshBalance(): Promise<number>;
+    redeemCode(code: string): Promise<{ result: string; eggsGiven: number; itemIds: number[]; }>;
+    claimURLReward(reward: string): Promise<{ result: string; eggsGiven: number; itemIds: number[]; }>;
+    claimSocialReward(rewardTag: string): Promise<{ result: string; eggsGiven: number; itemIds: number[]; }>;
+    buyItem(itemId: number): Promise<{ result: string; currentBalance: number; itemId: number; }>;
+
+    quit(noCleanup?: boolean): void;
 }
 
 export default Bot;

package/src/types/constants/challenges.d.ts

@@ -0,0 +1,19 @@
+export interface Challenge {
+    id: number;
+    loc_ref: string;
+    type: number;
+    subType: number;
+    period: number;
+    goal: number;
+    reward: number;
+    conditional: number;
+    value: string;
+    valueTwo: string | null;
+    tier: number;
+    loc: {
+        title: string;
+        desc: string;
+    }
+}
+
+export type Challenges = Challenge[];

package/src/types/constants/guns.d.ts

@@ -0,0 +1,240 @@
+declare class Gun {
+    dmgTypeId: number;
+    highPrecision: boolean;
+    equipTime: number;
+    stowWeaponTime: number;
+    accuracy: number;
+    shootingAccuracy: number;
+    movementAccuracy: number;
+    accuracyMax: number;
+    accuracyMin: number;
+    accuracyLoss: number;
+    accuracyRecover: number;
+    tracer: number;
+    burstQueue: number;
+    adsMod: number;
+    movementAccuracyMod: number;
+    reloadBloom: boolean;
+    reloadTimeMod: number;
+}
+
+declare class Eggk47 extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+}
+
+declare class DozenGauge extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+    adsMod: number;
+    movementAccuracyMod: number;
+}
+
+declare class CSG1 extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    hasScope: boolean;
+    longReloadTime: number;
+    shortReloadTime: number;
+    highPrecision: boolean;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+}
+
+declare class Cluck9mm extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+    adsMod: number;
+    movementAccuracyMod: number;
+}
+
+declare class RPEGG extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    hasScope: boolean;
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    radius: number;
+    totalDamage: number;
+    range: number;
+    minRange: number;
+    velocity: number;
+    accuracyMax: number;
+    accuracyMin: number;
+    accuracyLoss: number;
+    accuracyRecover: number;
+    absoluteMinAccuracy: number;
+}
+
+declare class SMG extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+    adsMod: number;
+    movementAccuracyMod: number;
+}
+
+declare class M24 extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    hasScope: boolean;
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+    movementAccuracyMod: number;
+    reloadBloom: boolean;
+    reloadTimeMod: number;
+}
+
+declare class AUG extends Gun {
+    ammo: {
+        rounds: number;
+        capacity: number;
+        reload: number;
+        store: number;
+        storeMax: number;
+        pickup: number;
+    };
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    movementInstability: number;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    tracer: number;
+    burst: number;
+    burstRof: number;
+    adsMod: number;
+    movementAccuracyMod: number;
+}
+
+export type AnyGun = Eggk47 | DozenGauge | CSG1 | Cluck9mm | RPEGG | SMG | M24 | AUG;
+
+export {
+    Eggk47,
+    DozenGauge,
+    CSG1,
+    Cluck9mm,
+    RPEGG,
+    SMG,
+    M24,
+    AUG
+}

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

@@ -0,0 +1,102 @@
+import { AUG, CSG1, DozenGauge, Eggk47, M24, RPEGG, SMG } from './guns';
+import { Item } from './items';
+
+export declare const findItemById: (id: number) => Item;
+
+export declare const ChiknWinnerDailyLimit: number;
+
+export declare const CollectTypes: {
+    AMMO: number;
+    GRENADE: number;
+};
+
+export declare const CoopStates: {
+    start: number;
+    score: number;
+    win: number;
+    capturing: number;
+    contested: number;
+    takeover: number;
+    abandoned: number;
+    unclaimed: number;
+};
+
+export declare const FirebaseKey: string;
+
+export declare const GameActions: {
+    reset: number;
+    pause: number;
+};
+
+export declare const GameModes: {
+    ffa: number;
+    team: number;
+    spatula: number;
+    kotc: number;
+};
+
+export declare const GameOptionFlags: {
+    locked: number;
+    noTeamChange: number;
+    noTeamShuffle: number;
+};
+
+export declare const GunList: Array<typeof Eggk47 | typeof DozenGauge | typeof CSG1 | typeof RPEGG | typeof SMG | typeof M24 | typeof AUG>;
+
+export declare const IsBrowser: boolean;
+
+export declare const ItemTypes: {
+    Hat: number;
+    Stamp: number;
+    Primary: number;
+    Secondary: number;
+    Grenade: number;
+    Melee: number;
+};
+
+export declare const Movements: {
+    FORWARD: number;
+    BACK: number;
+    LEFT: number;
+    RIGHT: number;
+    JUMP: number;
+    FIRE: number;
+    MELEE: number;
+    SCOPE: number;
+};
+
+export declare const PlayTypes: {
+    joinPublic: number;
+    createPrivate: number;
+    joinPrivate: number;
+};
+
+export declare const ProxiesEnabled: boolean;
+
+export declare const ShellStreaks: {
+    HardBoiled: number;
+    EggBreaker: number;
+    Restock: number;
+    OverHeal: number;
+    DoubleEggs: number;
+    MiniEgg: number;
+};
+
+export declare const SocialRewards: {
+    Discord: string;
+    Tiktok: string;
+    Instagram: string;
+    Steam: string;
+    Facebook: string;
+    Twitter: string;
+    Twitch: string;
+}
+
+export declare const Teams: {
+    blue: number;
+    red: number;
+};
+
+export declare const URLRewards: string[];
+
+export declare const UserAgent: string;

package/src/types/constants/items.d.ts

@@ -0,0 +1,21 @@
+export interface Item {
+    id: number;
+    name: string;
+    price: number;
+    item_type_id: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    item_type_name: 'Hat' | 'Stamp' | 'Primary' | 'Secondary' | 'Melee' | 'Grenade';
+    exclusive_for_class: null | 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    item_data: {
+        meshName: string;
+        tags: string[];
+    };
+    is_available: boolean;
+    unlock: 'default' | 'purchase' | 'physical' | 'manual' | 'premium' | 'vip';
+    align: {
+        x: number;
+        y: number;
+        z: number;
+    };
+}
+
+export type Items = Item[];

package/src/types/constants/maps.d.ts

@@ -0,0 +1,15 @@
+export interface Map {
+    filename: string;
+    hash: string;
+    name: string;
+    modes: {
+        FFA: boolean;
+        Teams: boolean;
+        Spatula: boolean;
+        King?: boolean;
+    };
+    availability: string;
+    numPlayers: string;
+}
+
+export type Maps = Map[];

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

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