blockmine 1.21.0 → 1.23.0

package/README.md

@@ -1,9 +1,8 @@
-
 <div align="center">
   <img src="./image/logo.png" alt="BlockMine Logo" width="150">
   <h1>BlockMine</h1>
   <p>
-    <strong>Мощная и удобная панель управления для ваших Minecraft-ботов на базе Mineflayer.</strong>
+    <strong>Мощная платформа управления Minecraft-ботами с визуальным программированием и продвинутой отладкой</strong>
   </p>
   <p>
     <a href="https://github.com/blockmineJS/blockmine/stargazers"><img src="https://img.shields.io/github/stars/blockmineJS/blockmine?style=for-the-badge&logo=github" alt="Stars"></a>
@@ -16,65 +15,71 @@
 
 **BlockMine** — это open-source решение для централизованного управления и автоматизации ботов Minecraft. Запускайте ботов, управляйте ими в реальном времени, расширяйте их возможности с помощью плагинов и создавайте сложные сценарии поведения в визуальном редакторе.
 
----
 
-<table align="center">
-  <tr>
-    <td align="center">
-      <p><strong>Дашборд</strong></p>
-      <img src="./image/1.png" alt="Скриншот дашборда" width="100%">
-      <em>Общая сводка и быстрое управление всеми ботами.</em>
-    </td>
-    <td align="center">
-      <p><strong>Магазин плагинов</strong></p>
-      <img src="./image/2.png" alt="Скриншот магазина плагинов" width="100%">
-      <em>Расширяйте возможности с помощью удобного браузера плагинов.</em>
-    </td>
-    <td align="center">
-      <p><strong>Управление командами</strong></p>
-      <img src="./image/3.png" alt="Скриншот страницы управления" width="100%">
-      <em>Настраивайте права алиасы и кулдауны для каждой команды.</em>
-    </td>
-  </tr>
-</table>
+Больше примеров на - https://t.me/blockmineJs
 
 ---
 
+
 ## 🚀 Ключевые возможности
 
-*   **💻 Современный веб-интерфейс**: Адаптивная панель на React и Tailwind CSS для управления ботами, серверами и плагинами с любого устройства.
-*   **✨ Визуальный редактор логики (No-Code)**: Проектируйте поведение ботов с помощью интуитивного Drag-and-Drop интерфейса. Создавайте сложные команды и обработчики событий, не написав ни строчки кода.
-*   **🤖 Комплексное управление ботами**:
-    *   Запуск, остановка и перезапуск ботов в один клик.
-    *   Интерактивная консоль для каждого бота.
-    *   Мониторинг ресурсов (CPU/RAM) в реальном времени.
-    *   Поддержка SOCKS5-прокси для каждого бота индивидуально.
-*   **🔌 Мощная система плагинов**:
-    *   Расширяйте функциональность с помощью плагинов.
-    *   Встроенный **браузер плагинов** с категориями и поиском.
-    *   Автоматическая проверка и установка зависимостей.
-    *   Настройка плагинов через графический интерфейс.
-*   **🔐 Гибкая система прав (Permissions)**:
-    *   Создавайте группы пользователей (`Admin`, `Member` и др.).
-    *   Настраивайте детальные права доступа к каждой команде.
-    *   Черный список для пользователей.
-*   **🔄 Экспорт и импорт**:
-    *   Создавайте **полные резервные копии** ботов в один ZIP-архив, включая все плагины и их настройки.
-    *   Делитесь отдельными командами и графами событий через экспорт в JSON.
-    *   Легко переносите ботов и их логику между разными установками BlockMine.
-*   **📦 Простая установка**: Запуск всей системы одной командой благодаря `npx`.
+### 💻 Современный веб-интерфейс
+- **Адаптивная панель** на React и Tailwind CSS для управления с любого устройства
+- **Темная тема** с современным дизайном
+- **Real-time обновления** через WebSocket
+
+### ✨ Визуальный редактор логики (No-Code)
+- **Drag-and-Drop интерфейс** для создания сложной логики без кода
+- **Live Debug режим** с брейкпоинтами и пошаговым выполнением
+- **Трассировка выполнения** с историей и значениями переменных
+- **Совместное редактирование** графов несколькими пользователями
+- **AI Ассистент** для помощи в создании логики
+
+### 🤖 Комплексное управление ботами
+- **Запуск/остановка/перезапуск** в один клик
+- **Интерактивная консоль** для каждого бота с историей
+- **Мониторинг ресурсов** (CPU/RAM) в реальном времени
+- **Поддержка SOCKS5-прокси** индивидуально для каждого бота
+- **Планировщик задач** с cron-расписаниями
+
+### 🔌 Мощная система плагинов
+- **Встроенный магазин** с категориями и поиском
+- **Автоматическая установка зависимостей**
+- **Настройка через GUI** без редактирования конфигов
+- **Hot-reload** плагинов без перезапуска бота
+
+### 🔐 Гибкая система прав
+- **Группы пользователей** (Admin, Member и др.)
+- **Детальные права доступа** для каждой команды
+- **Черный список** пользователей
+- **Кулдауны** и **алиасы** для команд
+
+### 🔄 Экспорт и импорт
+- **Полные резервные копии** ботов в ZIP-архив
+- **Экспорт/импорт** отдельных команд и графов
+- **Перенос между установками** BlockMine
+
+### 🔌 WebSocket API
+- **Управление ботами** из внешних приложений
+- **Выполнение команд** с полной проверкой прав
+- **Вызов визуальных графов** и получение результатов
+- **Подписка на события** (чат, игроки, здоровье и др.)
+- **SDK** `blockmine-sdk` для Node.js ⚠️ *(альфа-версия, не приоритет)*
+
+---
 
 ## ✨ Быстрый старт с `npx`
 
-Это самый простой способ запустить панель. Убедитесь, что у вас установлен **Node.js v18+**.
+Это самый простой способ запустить панель локально. Убедитесь, что у вас установлен **Node.js v22+**.
 
-1.  Откройте терминал (командную строку).
-2.  Выполните одну команду:
+1. Откройте терминал (командную строку)
+2. Выполните одну команду:
 
-    ```bash
-    npx blockmine
-    ```
-3.  Готово! Скрипт автоматически скачает все необходимое, настроит базу данных и запустит сервер.
+```bash
+npx blockmine
+```
+
+3. Готово! Скрипт автоматически скачает все необходимое, настроит базу данных и запустит сервер.
 
 > ⚠️ **Для пользователей Windows**: Если появляется ошибка `Невозможно загрузить файл ... npx.ps1, так как выполнение сценариев отключено`, откройте PowerShell от имени администратора и выполните `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser`. Нажмите 'Y' для подтверждения.
 
@@ -86,45 +91,204 @@
 
 ---
 
-## 💡 Основные концепции BlockMine
+## 🚀 Установка на хостинг (VPS/Dedicated Server)
+
+Для продакшн-развертывания на сервере рекомендуется использовать PM2 для управления процессом.
+
+### Требования
+- **Node.js v22+**
+- **npm**
+- **Git** (для клонирования репозитория)
+- **PM2** (менеджер процессов)
+
+### Шаг 1: Клонирование репозитория
+
+```bash
+git clone https://github.com/blockmineJS/blockmine.git
+cd blockmine
+```
+
+### Шаг 2: Установка зависимостей
+
+```bash
+npm install
+```
+
+> **Примечание**: Команда `npm install` автоматически запустит `postinstall` скрипт, который установит зависимости frontend и сгенерирует Prisma клиент.
 
-Чтобы максимально эффективно использовать панель, важно понимать её ключевые компоненты.
+### Шаг 3: Сборка frontend
+
+```bash
+npm run build
+```
+
+Эта команда создаст оптимизированную production-сборку React приложения.
+
+### Шаг 4: Установка PM2
+
+Если PM2 еще не установлен глобально:
+
+```bash
+npm install -g pm2
+```
+
+### Шаг 5: Запуск с PM2
+
+Запустите приложение с помощью готового конфигурационного файла:
+
+```bash
+pm2 start ecosystem.config.js
+```
+
+> **Примечание**: В проекте уже есть файл `ecosystem.config.js` с оптимальными настройками для production.
+
+
+### Обновление
+
+Для обновления до последней версии: НА ХОСТЕ! Для локального можно и без build. ибо там 5173
+
+```bash
+cd blockmine
+git pull
+npm install
+npm run build
+pm2 restart blockmine
+```
+
+---
+
+## 💡 Основные концепции BlockMine
 
 ### 🎨 Визуальный редактор
+
 <p align="center">
-  <img src="./image/visualcommand.png" alt="Скриншот визуального редактора BlockMine" width="100%">
+  <img src="./image/visualcommand.png" alt="Визуальный редактор" width="100%">
 </p>
-Это сердце No-Code автоматизации в BlockMine. Редактор позволяет вам создавать логику, перетаскивая и соединяя функциональные блоки (ноды).
 
-*   **Создание команд**: Спроектируйте полноценную команду с аргументами, проверками прав и сложной логикой, не прикасаясь к коду.
-*   **Обработка событий**: Создавайте ноды, которые реагируют на игровые события (например, вход игрока, сообщение в чате, появление моба) и выполняют заданные действия.
+Сердце No-Code автоматизации в BlockMine. Редактор позволяет создавать логику, перетаскивая и соединяя функциональные блоки (ноды).
+
+#### Возможности редактора:
+- **Создание команд** с аргументами, проверками прав и сложной логикой
+- **Обработка событий** (вход игрока, сообщения в чате, появление мобов)
+- **Live Debug** - отладка в реальном времени с брейкпоинтами
+- **Trace Viewer** - просмотр истории выполнения с значениями переменных
+- **Совместная работа** - несколько разработчиков могут редактировать одновременно
+- **AI ассистент** - помощь в создании логики
+
+### 🔍 Система отладки
+
+BlockMine предоставляет две мощные системы отладки:
+
+#### Live Debug (Живая отладка)
+- **Брейкпоинты** - остановка выполнения на конкретных нодах
+- **Условные брейкпоинты** - срабатывание при выполнении условия
+- **Пошаговое выполнение** - Step Over для детального анализа
+- **What-If режим** - изменение значений во время паузы
+- **Multi-user синхронизация** - все видят одно состояние отладки
+<td align="center">
+      <p><strong>🎨 Визуальный редактор с Live Debug</strong></p>
+      <img src="./screen/graph_live_debug.png" alt="Live Debug" width="100%">
+      <em>Отладка графов в реальном времени с брейкпоинтами и пошаговым выполнением</em>
+    </td>
+
+#### Trace Viewer (Просмотр трассировки)
+- **История выполнения** - сохранение всех запусков графа
+- **Значения переменных** - просмотр входов/выходов каждой ноды
+- **Воспроизведение** - пошаговый просмотр выполнения
+- **Временная шкала** - визуализация порядка выполнения нод
+<tr>
+    <td align="center">
+      <p><strong>🔍 Трассировка выполнения</strong></p>
+      <img src="./screen/node_debug_trace.png" alt="Trace Debug" width="100%">
+      <em>Пошаговая визуализация выполнения графа с историей и значениями переменных</em>
+    </td>
+  </tr>
+
 
 ### 🔌 Плагины
-Плагины — это способ программного расширения функциональности. Они могут добавлять новые команды, новые ноды для визуального редактора или работать в фоновом режиме.
 
-*   **Магазин плагинов**: Встроенный браузер позволяет легко находить и устанавливать плагины в один клик.
-*   **Зависимости**: Система автоматически определит и предложит установить плагины, необходимые для работы выбранного вами.
-*   **Настройка**: Большинство плагинов можно настроить прямо в веб-интерфейсе.
+<p align="center">
+  <img src="./screen/plugin_обзор.png" alt="Магазин плагинов" width="100%">
+  <br>
+  <em>Встроенный магазин плагинов с категориями, поиском и автоматической установкой зависимостей</em>
+</p>
+
+Плагины — это способ программного расширения функциональности. Они могут:
+- Добавлять новые команды
+- Создавать новые ноды для визуального редактора
+- Работать в фоновом режиме
+- Интегрироваться с внешними сервисами
+
+#### Возможности магазина плагинов
+- **Категории** - фильтрация по назначению (Ядро, Клан, Утилиты и др.)
+- **Автоматическая установка** - зависимости устанавливаются автоматически
+- **Настройка через GUI** - без редактирования конфигов
+- **Обновления** - проверка и установка обновлений
 
 ### ⚙️ Команды
-Команды могут быть созданы двумя способами: **программно** через плагины или **визуально** в редакторе. Независимо от способа создания, все команды управляются централизованно.
 
-*   **Алиасы**: Назначайте командам короткие псевдонимы (например, `@p` для `@ping`).
-*   **Кулдауны**: Устанавливайте задержку между использованиями команды.
-*   **Включение/выключение**: Временно отключайте команды.
-*   **Аргументы**: Задавайте аргументы для ваших визуальных команд, которые будут доступны внутри графа.
+Команды могут быть созданы двумя способами:
+
+#### Программные команды (через плагины)
+```javascript
+bot.registerCommand({
+  name: 'ping',
+  description: 'Проверка связи',
+  execute: async (context) => {
+    return `Понг, ${context.user.username}!`;
+  }
+});
+```
+
+#### Визуальные команды (через редактор)
+- **Drag-and-Drop** создание логики
+- **Аргументы** - определение типов и значений по умолчанию
+- **Условия** - проверка прав, времени суток и др.
+- **Циклы и ветвления** - сложная логика без кода
+
+#### Централизованное управление
+- **Алиасы** - короткие псевдонимы (например, `@p` для `@ping`)
+- **Кулдауны** - задержка между использованиями
+- **Разрешенные чаты** - chat, local, clan, private
+- **Включение/выключение** - временное отключение команд
 
 ### 🔐 Права и Группы (Permissions)
-Это гибкая система, позволяющая точно контролировать, кто и что может делать с вашим ботом.
 
-*   **Права (Permissions)**: Каждое действие (например, использование команды `@fly`) защищено правом (`user.fly`). Права могут создаваться плагинами или в панели управления.
-*   **Группы (Groups)**: Группы объединяют несколько прав. Например, группа `Member` может иметь право `member.say`.
-*   **Пользователи**: Каждый игрок, взаимодействующий с ботом, становится пользователем в системе. Вы можете добавлять пользователей в разные группы, выдавая им соответствующие права.
+Гибкая система контроля доступа:
+
+#### Права (Permissions)
+- Каждое действие защищено правом (например, `user.fly`)
+- Права создаются плагинами или в панели управления
+- Детальный контроль доступа
+
+#### Группы (Groups)
+- Объединение нескольких прав
+- Предустановленные группы: Admin, Member
+- Создание пользовательских групп
+
+#### Пользователи
+- Автоматическое добавление при взаимодействии с ботом
+- Назначение в группы
+- Черный список для блокировки
+
+### ⏰ Планировщик задач
+
+Автоматизируйте действия ботов по расписанию:
+- **Cron-выражения** - гибкая настройка времени
+- **Действия** - запуск/перезапуск бота, выполнение команд
+- **История запусков** - просмотр последних выполнений
+- **Включение/выключение** - временная деактивация задач
+
+---
 
 ## 🧑‍💻 Для разработчиков и контрибьюторов
 
 Если вы хотите внести свой вклад в проект или запустить его в режиме разработки.
 
+### Требования
+- **Node.js v22+**
+- **npm** или **yarn**
+
 ### 1. Установка
 
 ```bash
@@ -142,5 +306,85 @@ npm run build
 npm run dev
 ```
 
-*   **Бэкенд** будет доступен на `http://localhost:3001`.
-*   **Фронтенд** с горячей перезагрузкой будет доступен на `http://localhost:5173`. Открывайте этот адрес для разработки.
+- **Бэкенд** будет доступен на `http://localhost:3001`
+- **Фронтенд** с горячей перезагрузкой будет доступен на `http://localhost:5173`
+
+
+## 📸 Скриншоты
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <p><strong>📊 Дашборд</strong></p>
+      <img src="./screen/dashboard.png" alt="Dashboard" width="100%">
+      <em>Мониторинг ресурсов и управление всеми ботами в реальном времени</em>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <p><strong>👥 Совместная работа над графами</strong></p>
+      <img src="./screen/graph_collabe.png" alt="Collaboration" width="100%">
+      <em>Несколько разработчиков могут работать над одним графом одновременно</em>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <p><strong>💻 Интерактивная консоль</strong></p>
+      <img src="./screen/console.png" alt="Console" width="100%">
+      <em>Полноценная консоль бота с цветной подсветкой и историей команд</em>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <p><strong>⚙️ Управление командами</strong></p>
+      <img src="./screen/management_command.png" alt="Command Management" width="100%">
+      <em>Централизованное управление командами с алиасами и правами доступа</em>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <p><strong>🎛️ Настройки команд</strong></p>
+      <img src="./screen/настройки_отдельных_команд_кажду_команлду_можно_настраивать.png" alt="Command Settings" width="100%">
+      <em>Гибкая настройка каждой команды: алиасы, кулдауны, права и разрешенные чаты</em>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <p><strong>⏰ Планировщик задач</strong></p>
+      <img src="./screen/планировщик_можно_задавать_действия_по_времени.png" alt="Scheduler" width="100%">
+      <em>Автоматизируйте действия ботов с помощью cron-расписаний</em>
+    </td>
+  </tr>
+</table>
+
+---
+
+---
+
+## 🤝 Вклад в проект
+
+Мы приветствуем ваш вклад! Вот как вы можете помочь:
+
+1. **Fork** репозитория
+2. Создайте ветку для вашей фичи (`git checkout -b feature/amazing-feature`)
+3. Commit ваши изменения (`git commit -m 'feat: добавлена потрясающая фича'`)
+4. Push в ветку (`git push origin feature/amazing-feature`)
+5. Откройте **Pull Request**
+
+### Стиль коммитов
+
+Мы используем [Conventional Commits](https://www.conventionalcommits.org/):
+- `feat:` - новая функциональность
+- `fix:` - исправление бага
+- `docs:` - изменения в документации
+- `chore:` - рутинные задачи (обновление зависимостей и т.д.)
+
+---
+
+---
+
+<div align="center">
+  <p>
+    <a href="https://github.com/blockmineJS/blockmine">⭐ Поставьте звезду на GitHub</a>
+  </p>
+</div>