specprotocol 1.0.0

package/dist/bot.d.ts

@@ -0,0 +1,190 @@
+/**
+ * Bot — the main orchestrator class.
+ *
+ * This is the primary entry point for users. It coordinates:
+ * - TCP connection to the server
+ * - Authentication (offline or Microsoft)
+ * - Protocol state transitions (Handshake → Login → Configuration → Play)
+ * - Keep-alive responses
+ * - Entity and world state management
+ * - Plugin system
+ * - High-level API (chat, move, dig, attack)
+ */
+import { TypedEventEmitter } from './utils/events.js';
+import { LogLevel } from './utils/logger.js';
+import { Vec3 } from './utils/vec3.js';
+import { type RawPacket } from './protocol/packet.js';
+import { World } from './world/world.js';
+import { Entity, EntityManager } from './entity/entity.js';
+import { PluginManager, type Plugin } from './plugins/plugin-manager.js';
+export interface BotEvents {
+    /** Login complete, entering play state */
+    'login': () => void;
+    /** Spawned in the world */
+    'spawn': () => void;
+    /** Received a chat message */
+    'chat': (message: string, isOverlay: boolean) => void;
+    /** Health updated */
+    'health': (health: number, food: number, saturation: number) => void;
+    /** Bot died */
+    'death': () => void;
+    /** Disconnected from server */
+    'kicked': (reason: string) => void;
+    /** Position updated by server */
+    'position': (position: Vec3) => void;
+    /** Entity spawned */
+    'entitySpawn': (entity: Entity) => void;
+    /** Entity removed */
+    'entityRemove': (entityId: number) => void;
+    /** Block updated */
+    'blockUpdate': (x: number, y: number, z: number, stateId: number) => void;
+    /** Raw packet received (for advanced use) */
+    'rawPacket': (packet: RawPacket) => void;
+    /** Connection error */
+    'error': (error: Error) => void;
+    /** Connected to server */
+    'connect': () => void;
+    /** Disconnected */
+    'end': () => void;
+}
+export interface BotOptions {
+    host: string;
+    port?: number;
+    username: string;
+    /** 'offline' for cracked servers, 'microsoft' for online mode */
+    auth?: 'offline' | 'microsoft';
+    /** Protocol version (default: latest supported) */
+    version?: number;
+    /** View distance to request */
+    viewDistance?: number;
+    /** Log level */
+    logLevel?: LogLevel;
+    /** Plugins to load */
+    plugins?: Plugin[];
+}
+export declare class Bot extends TypedEventEmitter<BotEvents> {
+    private connection;
+    private logger;
+    private _username;
+    private _uuid;
+    private _entityId;
+    private _health;
+    private _food;
+    private _saturation;
+    private _gameMode;
+    private _isAlive;
+    private authMode;
+    private accessToken?;
+    readonly world: World;
+    readonly entities: EntityManager;
+    readonly plugins: PluginManager;
+    readonly entity: Entity;
+    private readonly options;
+    private packetHandlers;
+    constructor(options: BotOptions);
+    get username(): string;
+    get uuid(): string;
+    get entityId(): number;
+    get health(): number;
+    get food(): number;
+    get saturation(): number;
+    get gameMode(): number;
+    get isAlive(): boolean;
+    get position(): Vec3;
+    /**
+     * Connect to the server and begin the login process.
+     */
+    connect(): Promise<void>;
+    private performLogin;
+    private handleLoginSequence;
+    private handleLoginPacket;
+    private handleEncryptionRequest;
+    /**
+     * Handle Configuration state packets after Login Acknowledged.
+     * In 1.20.2+, the server sends registry data, feature flags, etc. before Play.
+     * When the server sends Finish Configuration (0x03), we transition to Play.
+     *
+     * 1.21.4 Configuration Clientbound Packet IDs:
+     *   0x00 = Cookie Request
+     *   0x01 = Plugin Message
+     *   0x02 = Disconnect
+     *   0x03 = Finish Configuration
+     *   0x04 = Keep Alive
+     *   0x05 = Ping
+     *   0x07 = Registry Data
+     *   0x09 = Add Resource Pack
+     *   0x0C = Feature Flags
+     *   0x0D = Update Tags
+     *   0x0E = Known Packs
+     *   0x10 = Server Links
+     */
+    private handleConfigurationState;
+    private setupPlayStateHandlers;
+    private handlePlayPacket;
+    /**
+     * Register a handler for a specific play-state packet ID.
+     * Used by plugins to listen for specific packets.
+     */
+    onPacket(packetId: number, handler: (data: Buffer) => void): void;
+    /**
+     * Send a raw packet to the server.
+     */
+    sendPacket(packetId: number, data: Buffer): void;
+    /**
+     * Send a chat message.
+     */
+    chat(message: string): void;
+    /**
+     * Attack an entity.
+     */
+    attack(entity: Entity): void;
+    /**
+     * Set the bot's position (sends position packet to server).
+     */
+    setPosition(x: number, y: number, z: number, onGround?: boolean): void;
+    /**
+     * Set position and rotation.
+     */
+    setPositionAndRotation(x: number, y: number, z: number, yaw: number, pitch: number, onGround?: boolean): void;
+    /**
+     * Look at a position.
+     */
+    lookAt(target: Vec3): void;
+    /**
+     * Start digging a block.
+     */
+    dig(x: number, y: number, z: number, face?: number): void;
+    /**
+     * Select a hotbar slot (0-8).
+     */
+    setHeldItem(slot: number): void;
+    /**
+     * Disconnect from the server.
+     */
+    disconnect(): void;
+}
+/**
+ * Create and connect a bot.
+ *
+ * @example
+ * ```ts
+ * import { createBot } from 'mcbot';
+ *
+ * const bot = await createBot({
+ *   host: 'localhost',
+ *   port: 25565,
+ *   username: 'Bot',
+ *   auth: 'offline',
+ * });
+ *
+ * bot.on('chat', (message) => {
+ *   console.log('Chat:', message);
+ * });
+ *
+ * bot.on('spawn', () => {
+ *   bot.chat('Hello world!');
+ * });
+ * ```
+ */
+export declare function createBot(options: BotOptions): Promise<Bot>;
+//# sourceMappingURL=bot.d.ts.map

package/dist/bot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot.d.ts","sourceRoot":"","sources":["../src/bot.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAU,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AA6CtD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAgB,MAAM,oBAAoB,CAAC;AAGzE,OAAO,EAAE,aAAa,EAAE,KAAK,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAMzE,MAAM,WAAW,SAAS;IACtB,0CAA0C;IAC1C,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,8BAA8B;IAC9B,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACtD,qBAAqB;IACrB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IACrE,eAAe;IACf,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,+BAA+B;IAC/B,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,iCAAiC;IACjC,UAAU,EAAE,CAAC,QAAQ,EAAE,IAAI,KAAK,IAAI,CAAC;IACrC,qBAAqB;IACrB,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,qBAAqB;IACrB,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3C,oBAAoB;IACpB,aAAa,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1E,6CAA6C;IAC7C,WAAW,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC;IACzC,uBAAuB;IACvB,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAChC,0BAA0B;IAC1B,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,mBAAmB;IACnB,KAAK,EAAE,MAAM,IAAI,CAAC;CACrB;AAID,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAID,qBAAa,GAAI,SAAQ,iBAAiB,CAAC,SAAS,CAAC;IAEjD,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,MAAM,CAAS;IAGvB,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,QAAQ,CAAiB;IAGjC,OAAO,CAAC,QAAQ,CAA0B;IAC1C,OAAO,CAAC,WAAW,CAAC,CAAS;IAG7B,SAAgB,KAAK,EAAE,KAAK,CAAC;IAC7B,SAAgB,QAAQ,EAAE,aAAa,CAAC;IACxC,SAAgB,OAAO,EAAE,aAAa,CAAC;IACvC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAG/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2E;IAGnG,OAAO,CAAC,cAAc,CAAoD;gBAE9D,OAAO,EAAE,UAAU;IA6C/B,IAAI,QAAQ,IAAI,MAAM,CAA2B;IACjD,IAAI,IAAI,IAAI,MAAM,CAAuB;IACzC,IAAI,QAAQ,IAAI,MAAM,CAA2B;IACjD,IAAI,MAAM,IAAI,MAAM,CAAyB;IAC7C,IAAI,IAAI,IAAI,MAAM,CAAuB;IACzC,IAAI,UAAU,IAAI,MAAM,CAA6B;IACrD,IAAI,QAAQ,IAAI,MAAM,CAA2B;IACjD,IAAI,OAAO,IAAI,OAAO,CAA0B;IAChD,IAAI,QAAQ,IAAI,IAAI,CAAiC;IAIrD;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;YAehB,YAAY;YAyCZ,mBAAmB;IAyBjC,OAAO,CAAC,iBAAiB;IA2DzB,OAAO,CAAC,uBAAuB;IAyC/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,wBAAwB;IAqHhC,OAAO,CAAC,sBAAsB;IAmB9B,OAAO,CAAC,gBAAgB;IAyIxB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAMjE;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAMhD;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAO3B;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAO5B;;OAEG;IACH,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAc,GAAG,IAAI;IAS5E;;OAEG;IACH,sBAAsB,CAClB,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAC/B,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAC1B,QAAQ,GAAE,OAAc,GACzB,IAAI;IAWP;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI;IAsB1B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,GAAG,IAAI;IAgB5D;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQ/B;;OAEG;IACH,UAAU,IAAI,IAAI;CAKrB;AAID;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAIjE"}