ddbot.js-0374 3.2.7 → 4.0.0

package/docs/documentation.md

@@ -1,141 +0,0 @@
-# bot/BotManager
-
-установка
-"npm i ddbot.js-0374"
-
-
-Ето модуль для роботы с ДДНет (DDNet/teeworlds) ботами. внутри изпользует чистую библиотеку teeworlds (https://www.npmjs.com/package/teeworlds, https://www.npmjs.com/~swarfey) и просто делает рутинные вещи за вас. Например, может работать с кучей ботов на разных серверах, делает чат не повторяющимся без спамов. Убирает системные сообщения из чата. Можно получить весь список игроков одним методом.
-
-Вообще я делал его для себя, и по приколу. Но решил выложить чтобы проще работать с зависимостями и не качать с гита.
-
-
-Окей...
-Сейчас я вам разкажу как работает bot/BotManager.
-
-teeworlds
-## методы
-У нас есть :
-1. bot.createBot()
-	1. fulladdress - Полный адрес сервера (IP:порт)
-	2. botName - Имя бота
-	3. parameter - Параметры бота
-	    1. identity со скином и другими косметическими деталями.
-	    2. reconnect переподключаеться бот или нет
-	    3. reconnectAttempts количество возможных реконектов (-1 для безконечного)
-	    4. randreconnect будет ли бот переключаться с чуть разной задержкой или нет (в районе 0 - 1 сек)
-	- На выходе у нас имя бота по которому можно обращаться. (Уникальное имя бота или null в случае ошибки)
-2. bot.connectBot()
-    1. Принимает уникальное имя бота и подключает нужного.
-    - На выхоте булевое значение (нет точных данных подключился ли бот или нет)
-3. bot.disconnectBot()
-    1. Принимает уникальное имя бота и отключает нужного.
-    - Работает также как и connectBot().
-4. bot.disconnectAllBots()
-    Отключает всех ботов, не принимает аргументов.
-    Под капотом disconnectBot().
-5. bot.getBotInfo()
-    1. Принимает уникальное имя бота и возвращает информацию про него.
-    - Информация о боте или null, если бот не найден
-6. bot.isBotConnected()
-    1. Принимает уникальное имя бота.
-    - Возвращает булевое значение.
-7. bot.isFreezeBot()
-    1. Принимает уникальное имя бота.
-    - Возвращает булевое значение.
-8. bot.setFreezeBot()
-    Просто меняет значение того заморожен ли бот. (не влияет на игру)
-9. bot.getAllActiveBots()
-	Получение всех активных ботов
-	- Массив имен всех активных ботов
-10. bot.getBotClient()
-    1. Принимает уникальное имя бота.
-    - Возвращает клиент teeworlds
-11. bot.removeBot()
-	Удаляет бота полностью. (и отключает)
-    1. Принимает уникальное имя бота.
-    - Возвращает булевое значение.
-12. bot.getBot()
-    1. Принимает уникальное имя бота.
-    - Возвращает прокси-объект бота.
-13. bot._setupBotEvents()
-    Заставляет ивенты работать. Изпользуеться в bot.createBot() чтобы вы могли делать все проще и вам не нужно было получать оригинальный клиент teeworlds для ивентов.
-    1. Принимает уникальное имя бота.
-    2. Принимает клиент teeworlds
-    Ничего не возвращает.
-14. bot.getPlayerList()
-    1. Принимает уникальное имя бота.
-    - Array список игроков.
-15. bot.getPlayerName()
-    1. Принимает уникальное имя бота/Array список игроков.
-    2. clientid нужного игрока.
-    - Имя нужного игрока.
-
-## пример ехо бота
-```js
-// Пример писался под комит c453b96f9fd717375f5ff70525603b7e1491c290.
-
-const DebugLogger = require('loger0374'); // мой логер (не обязательно изпользовать)
-const { bot, botClassAndLoger } = require('../../index');
-const botdebug = botClassAndLoger.logDebuger;
-botdebug.setDebugMode(true, true, true);
-
-const logDebuger = new DebugLogger('example', true, true, null, true);
-
-async function main() {
-    logDebuger.logDebug('Main started');
-
-    const identitybot = {
-        name: "Towa",
-        clan: "Towa Team",
-        skin: "Astolfofinho",
-        use_custom_color: 1,
-        color_body: 16711680,
-        color_feet: 16711680,
-        country: 804
-    };
-
-    const botName = await bot.createBot('45.141.57.22:8311', 'Towa', {
-        identity: identitybot,
-        reconnect: true,
-        reconnectAttempts: -1,
-        randreconnect: true
-    });
-
-    bot.connectBot(botName); // подкюлчаем
-
-    const botClient = bot.getBotClient(botName); // получаем оригинальный клиент teeworlds
-
-    // Подписка на событие подключения
-    bot.on(`${botName}:connect`, () => {
-        let timemsg = 0; // время
-
-        setTimeout(() => {
-            botClient.game.Say('Ку всем');
-        }, 1251);
-
-        // подписка на чат
-        bot.on(`${botName}:ChatNoSystem`, (msgraw, autormsg, text, team, client_id) => {
-            logDebuger.logDebug(`${client_id} ${team} '${autormsg}' : ${text}`); // вывод чата в консоль
-            if (text == 'exit') exit(); // выход
-
-            // Эхо-логика
-            if (Date.now() - timemsg > 6000) {
-                timemsg = Date.now(); // устанавливаем текущее время
-                if (text && autormsg) {
-                    botClient.game.Say(`${autormsg}: ${text}`); // отправка сообения (teeworlds)
-                }
-            }
-        });
-    });
-
-    // Выход через Ctrl+C
-    async function exit() {
-        logDebuger.logDebug('Shutting down...');
-        await bot.disconnectAllBots(); // отключаем всех ботов
-        process.exit(0); // завершаем процес
-    }
-    process.on('SIGINT', exit); // Ctrl+C
-}
-
-if (require.main === module) main();
-```

package/index.js

@@ -1,14 +1,4 @@
-"use strict";
-const { bot, BotManager, logDebuger } = require('./src/bot'); // Импортируем bot и BotManager из модуля bot/index.js
-
-/**
- * Зделал так чтобы было меньше експорта.
- * Тут у нас не активированый BotManager.
- * И logDebuger который изпользуеться в BotManager, а точнее в bot.
- */
-const botClassAndLoger = {
-    BotManager,
-    logDebuger
-}
-
-module.exports = { bot, botClassAndLoger }; // Экспортируем bot, mapLoader, Automaploader, botClassAndLoger и DebugLogger
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ddbot = require("./lib/index");
+exports.default = ddbot;

package/lib/core/core.d.ts

@@ -0,0 +1,105 @@
+import { Client } from 'teeworlds';
+import { EventEmitter } from 'events';
+import * as Types from '../types.js';
+interface BotEvents {
+    connect: (info: Types.ConnectionInfo) => void;
+    disconnect: (reason: string | null, info: Types.ConnectionInfo) => void;
+    broadcast: (message: string) => void;
+    capabilities: (message: {
+        ChatTimeoutCode: boolean;
+        AnyPlayerFlag: boolean;
+        PingEx: boolean;
+        AllowDummy: boolean;
+        SyncWeaponInput: boolean;
+    }) => void;
+    emote: (message: Types.SnapshotItemTypes.iEmoticon) => void;
+    kill: (kill: Types.SnapshotItemTypes.iKillMsg) => void;
+    snapshot: (items: Types.DeltaItem[]) => void;
+    map_change: (message: Types.SnapshotItemTypes.iMapChange) => void;
+    motd: (message: string) => void;
+    message: (message: Types.SnapshotItemTypes.iMessage) => void;
+    teams: (teams: Array<number>) => void;
+    teamkill: (teamkill: Types.SnapshotItemTypes.iKillMsgTeam) => void;
+    spawn: (msg: Types.SnapshotItemTypes.Spawn) => void;
+    death: (msg: Types.SnapshotItemTypes.Death) => void;
+    hammerhit: (msg: Types.SnapshotItemTypes.HammerHit) => void;
+    sound_world: (msg: Types.SnapshotItemTypes.SoundWorld) => void;
+    explosion: (msg: Types.SnapshotItemTypes.Explosion) => void;
+    common: (msg: Types.SnapshotItemTypes.Common) => void;
+    damage_indicator: (msg: Types.SnapshotItemTypes.DamageInd) => void;
+    sound_global: (msg: Types.SnapshotItemTypes.SoundGlobal) => void;
+}
+interface BotStatus {
+    connect: {
+        connected: boolean;
+        connecting: boolean;
+    };
+    addr: string | null;
+    port: number | null;
+}
+export declare class Bot extends EventEmitter {
+    private teeworlds;
+    private client;
+    private _clientProxy;
+    options: Types.SnapshotItemTypes.iOptions;
+    identity: Types.SnapshotItemTypes.Identity;
+    status: BotStatus;
+    constructor(identity?: Types.SnapshotItemTypes.Identity, options?: Types.SnapshotItemTypes.iOptions, CustomTeeworlds?: typeof import('teeworlds'));
+    /**
+     * Get bot identity
+     */
+    get bot_identity(): Types.SnapshotItemTypes.Identity;
+    /**
+     * Create new Teeworlds client instance
+     */
+    private create_client;
+    /**
+     * Clean up client event listeners
+     */
+    private clean;
+    /**
+     * Connect to a DDNet server
+     * @param addr - Server address
+     * @param port - Server port (default: 8303)
+     * @param timeout - Connection timeout in ms (default: 5000)
+     * @returns Promise with connection info
+     */
+    connect(addr: string, port?: number, timeout?: number): Promise<Types.ConnectionInfo>;
+    /**
+     * Disconnect from server
+     * @returns Promise with disconnection info or null
+     */
+    disconnect(): Promise<Types.ConnectionInfo | null>;
+    /**
+     * Change bot identity (name, skin, colors, etc.)
+     * @param identity - New identity or partial identity update
+     */
+    change_identity(identity: Types.SnapshotItemTypes.Identity | Partial<Types.SnapshotItemTypes.Identity>): void;
+    /**
+     * Send input to the game (movement, aim, actions)
+     * @param input - Partial input object
+     */
+    send_input(input: Partial<Types.SnapshotItemTypes.PlayerInput>): void;
+    /**
+     * Setup all client event listeners and forward them
+     */
+    private client_events;
+    private setup_snapshot_events;
+    /**
+     * Get bot's own client ID
+     */
+    get OwnID(): number | undefined;
+    /**
+     * Get proxied client instance for safe access
+     */
+    get bot_client(): Client | null;
+    /**
+     * Destroy bot instance and clean up all resources
+     */
+    destroy(): Promise<void>;
+    on<K extends keyof BotEvents>(event: K, listener: BotEvents[K]): this;
+    once<K extends keyof BotEvents>(event: K, listener: BotEvents[K]): this;
+    emit<K extends keyof BotEvents>(event: K, ...args: Parameters<BotEvents[K]>): boolean;
+    off<K extends keyof BotEvents>(event: K, listener: BotEvents[K]): this;
+}
+export default Bot;

package/lib/core/core.js

@@ -0,0 +1,270 @@
+"use strict";
+import { Client } from 'teeworlds';
+import * as Teeworlds from 'teeworlds';
+import { EventEmitter } from 'events';
+import * as DDUtils from './ddutils.js';
+import * as Types from '../types.js';
+export class Bot extends EventEmitter {
+    teeworlds;
+    client = null;
+    _clientProxy = null;
+    options;
+    identity;
+    status = {
+        connect: {
+            connected: false,
+            connecting: false,
+        },
+        addr: null,
+        port: null,
+    };
+    constructor(identity, options = {}, CustomTeeworlds = Teeworlds) {
+        super();
+        this.teeworlds = CustomTeeworlds;
+        this.options = options;
+        this.identity = DDUtils.IsValidIdentity(identity)
+            ? identity
+            : DDUtils.DefaultIdentity('nameless tee');
+    }
+    /**
+     * Get bot identity
+     */
+    get bot_identity() {
+        return this.identity;
+    }
+    /**
+     * Create new Teeworlds client instance
+     */
+    create_client(addr, port) {
+        this.disconnect();
+        this.clean(true);
+        this.client = new this.teeworlds.Client(addr, port, this.identity.name, {
+            ...this.options,
+            identity: this.identity,
+        });
+        this.client.movement.FlagScoreboard(true);
+        this.client_events();
+    }
+    /**
+     * Clean up client event listeners
+     */
+    clean(clear = false) {
+        try {
+            if (!this.client)
+                return;
+            this.client.removeAllListeners();
+            this.client.SnapshotUnpacker?.removeAllListeners();
+            if (clear) {
+                this.client = null;
+            }
+        }
+        catch (e) {
+            console.error('Error during clean:', e);
+        }
+    }
+    /**
+     * Connect to a DDNet server
+     * @param addr - Server address
+     * @param port - Server port (default: 8303)
+     * @param timeout - Connection timeout in ms (default: 5000)
+     * @returns Promise with connection info
+     */
+    connect(addr, port = 8303, timeout = 5000) {
+        if (typeof addr !== 'string' || typeof port !== 'number') {
+            return Promise.reject(new Error('Invalid address or port'));
+        }
+        if (timeout <= 0) {
+            return Promise.reject(new Error('Timeout must be positive'));
+        }
+        if (this.status.connect.connected || this.status.connect.connecting) {
+            return Promise.reject(new Error('Already connected or connecting'));
+        }
+        this.status.connect.connecting = true;
+        this.status.addr = addr;
+        this.status.port = port;
+        return new Promise((resolve, reject) => {
+            this.create_client(addr, port);
+            let settled = false;
+            const cleanup = () => {
+                this.off('connect', onConnect);
+                this.off('disconnect', onDisconnect);
+            };
+            const onConnect = () => {
+                if (settled)
+                    return;
+                settled = true;
+                clearTimeout(timer);
+                cleanup();
+                this.status.connect.connecting = false;
+                resolve({ addr: this.status.addr, port: this.status.port });
+            };
+            const onDisconnect = (reason) => {
+                if (settled)
+                    return;
+                settled = true;
+                clearTimeout(timer);
+                cleanup();
+                this.status.connect.connecting = false;
+                reject(new Error(`Disconnected during connect: ${reason ?? 'unknown reason'}`));
+            };
+            const timer = setTimeout(() => {
+                if (settled)
+                    return;
+                settled = true;
+                cleanup();
+                this.status.connect.connecting = false;
+                this.clean(true);
+                reject(new Error('Connection timeout'));
+            }, timeout);
+            this.once('connect', onConnect);
+            this.once('disconnect', onDisconnect);
+            this.client.connect();
+        });
+    }
+    /**
+     * Disconnect from server
+     * @returns Promise with disconnection info or null
+     */
+    async disconnect() {
+        this.status.connect.connecting = false;
+        let info = null;
+        if (this.client && this.status.connect.connected) {
+            try {
+                await this.client.Disconnect();
+            }
+            catch (e) {
+                console.error('Error during disconnect:', e);
+            }
+            this.status.connect.connected = false;
+            info = { addr: this.status.addr, port: this.status.port };
+            this.emit('disconnect', null, info);
+        }
+        this.clean(true);
+        return info;
+    }
+    /**
+     * Change bot identity (name, skin, colors, etc.)
+     * @param identity - New identity or partial identity update
+     */
+    change_identity(identity) {
+        this.identity =
+            typeof identity === 'object' && identity !== null
+                ? { ...this.identity, ...identity }
+                : DDUtils.DefaultIdentity(this.identity.name);
+        if (this.client && this.status.connect.connected) {
+            this.client.game.ChangePlayerInfo(this.identity);
+        }
+    }
+    /**
+     * Send input to the game (movement, aim, actions)
+     * @param input - Partial input object
+     */
+    send_input(input) {
+        if (!this.client)
+            return;
+        this.client.movement.input = { ...this.client.movement.input, ...input };
+    }
+    /**
+     * Setup all client event listeners and forward them
+     */
+    client_events() {
+        this.clean(false);
+        if (!this.client)
+            return;
+        // Connection events
+        this.client.on('connected', () => {
+            this.status.connect.connected = true;
+            this.emit('connect', { addr: this.status.addr, port: this.status.port });
+            this.setup_snapshot_events();
+        });
+        this.client.on('disconnect', (reason = null) => {
+            this.status.connect.connected = false;
+            this.clean(true);
+            if (reason) {
+                this.emit('disconnect', reason, { addr: this.status.addr, port: this.status.port });
+            }
+        });
+        // Game events
+        this.client.on('broadcast', (msg) => this.emit('broadcast', msg));
+        this.client.on('capabilities', (msg) => this.emit('capabilities', msg));
+        this.client.on('emote', (msg) => this.emit('emote', msg));
+        this.client.on('kill', (msg) => this.emit('kill', msg));
+        this.client.on('snapshot', (msg) => this.emit('snapshot', msg));
+        this.client.on('map_change', (msg) => this.emit('map_change', msg));
+        this.client.on('motd', (msg) => this.emit('motd', msg));
+        this.client.on('message', (msg) => this.emit('message', msg));
+        this.client.on('teams', (msg) => this.emit('teams', msg));
+        this.client.on('teamkill', (msg) => this.emit('teamkill', msg));
+    }
+    /*
+     * Setup snapshot unpacker events
+     */
+    setup_snapshot_events() {
+        if (!this.client?.SnapshotUnpacker) {
+            console.warn('SnapshotUnpacker not available yet');
+            return;
+        }
+        this.client.SnapshotUnpacker.on('spawn', (msg) => this.emit('spawn', msg));
+        this.client.SnapshotUnpacker.on('death', (msg) => this.emit('death', msg));
+        this.client.SnapshotUnpacker.on('hammerhit', (msg) => this.emit('hammerhit', msg));
+        this.client.SnapshotUnpacker.on('sound_world', (msg) => this.emit('sound_world', msg));
+        this.client.SnapshotUnpacker.on('explosion', (msg) => this.emit('explosion', msg));
+        this.client.SnapshotUnpacker.on('common', (msg) => this.emit('common', msg));
+        this.client.SnapshotUnpacker.on('damage_indicator', (msg) => this.emit('damage_indicator', msg));
+        this.client.SnapshotUnpacker.on('sound_global', (msg) => this.emit('sound_global', msg));
+    }
+    /**
+     * Get bot's own client ID
+     */
+    get OwnID() {
+        if (!this.client || !this.status.connect.connected)
+            return undefined;
+        return this.client.SnapshotUnpacker?.OwnID;
+    }
+    /**
+     * Get proxied client instance for safe access
+     */
+    get bot_client() {
+        if (!this.client)
+            return null;
+        if (!this._clientProxy) {
+            const self = this;
+            this._clientProxy = new Proxy({}, {
+                get(target, prop) {
+                    if (!self.client)
+                        return undefined;
+                    const value = self.client[prop];
+                    return typeof value === 'function' ? value.bind(self.client) : value;
+                },
+                set(target, prop, value) {
+                    if (!self.client)
+                        return false;
+                    self.client[prop] = value;
+                    return true;
+                },
+            });
+        }
+        return this._clientProxy;
+    }
+    /**
+     * Destroy bot instance and clean up all resources
+     */
+    async destroy() {
+        await this.disconnect();
+        this.removeAllListeners();
+        this._clientProxy = null;
+    }
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    once(event, listener) {
+        return super.once(event, listener);
+    }
+    emit(event, ...args) {
+        return super.emit(event, ...args);
+    }
+    off(event, listener) {
+        return super.off(event, listener);
+    }
+}
+export default Bot;

package/lib/core/ddutils.d.ts

@@ -0,0 +1,33 @@
+export interface ConnectionInfo {
+    addr: string;
+    port: number;
+}
+export interface Identity {
+    name: string;
+    clan: string;
+    skin: string;
+    use_custom_color: 0 | 1;
+    color_body: number;
+    color_feet: number;
+    country: number;
+}
+export interface Input {
+    m_Direction: -1 | 0 | 1;
+    m_TargetX: number;
+    m_TargetY: number;
+    m_Jump: 0 | 1;
+    m_Fire: 0 | 1;
+    m_Hook: 0 | 1;
+    m_PlayerFlags: number;
+    m_WantedWeapon: 1 | 2 | 3 | 4 | 5 | 6;
+    m_NextWeapon: 0 | 1;
+    m_PrevWeapon: 0 | 1;
+}
+export declare function DefaultIdentity(name?: string): Identity;
+export declare function IsValidIdentity(identity: unknown): identity is Identity;
+export declare function IsValidClient(client: unknown): boolean;
+export declare function IsValidInput(input: unknown): input is Input;
+export declare function random(min: number, max: number): number;
+export declare function connectionInfo(): ConnectionInfo;
+import type { SnapshotItemTypes } from '../types.js';
+export declare function reconstructPlayerInput(char: SnapshotItemTypes.Character, ddnetChar?: SnapshotItemTypes.DDNetCharacter | null, tick?: number | null): SnapshotItemTypes.PlayerInput;