Добро пожаловать в RainyBot!

Обзор

RainyBot — это кроссплатформенный фреймворк для разработки чат-ботов, основанный на Godot Engine 4.0. Цель проекта — создать простой и удобный фреймворк для разработчиков с небольшим опытом или без опыта. Предоставляя множество тщательно разработанных, интеллектуальных и упрощённых интерактивных API и предустановленных функций, а также используя простой синтаксис GDScript, RainyBot стремится максимально повысить эффективность разработки и снизить сложность разработки, позволяя большему количеству пользователей с ограниченным опытом или даже без опыта легко разрабатывать собственных чат-ботов для различных социальных платформ.

Например, RainyBot предоставляет разработчикам множество высокоуровневых и интуитивно понятных API для таких операций, как контекстное взаимодействие, регистрация команд/событий/ключевых слов и построение сообщений, что позволяет реализовать сложные функции с помощью минимального кода.

Кроме того, благодаря мощным графическим возможностям Godot Engine, RainyBot обладает значительными преимуществами перед другими ботами в области статического и динамического создания изображений; с помощью простого в использовании редактора Godot Engine и тщательно продуманного API для создания изображений, вы можете быстро и легко создавать функции создания изображений с минимальными усилиями.

RainyBot разработал серию удобных абстрактных API, которые связывают различные API с соответствующими адаптерами и взаимодействуют с соответствующими социальными платформами. В настоящее время RainyBot реализует адаптер на основе Mirai Api Http, который является плагином для Mirai QQ и позволяет разработчикам взаимодействовать с Mirai QQ через протоколы Http/Websocket и реализовывать функции QQ-бота.

Для всех задач, критичных к производительности, RainyBot внутренне использует асинхронное выполнение и многопоточность для обеспечения параллелизма и пропускной способности сообщений при высоких нагрузках. Кроме того, все API, требующие асинхронного выполнения, гибко используют характеристики ожидания для реализации однострочного кода для запроса и получения результатов асинхронных задач.

Особенности

• Модульная конструкция: большинство API могут работать независимо от протокола бэкенда и могут быть адаптированы к различным протоколам для работы в разных местах (в настоящее время поддерживается протокол Mirai-Api-Http).
• Простота настройки и управления: после однократной настройки автоматически управляет конфигурацией/запуском/подключением всех протоколов бэкенда, не требуя ручного запуска или настройки каждый раз.
• Простой, полный, удобный и интеллектуальный API: можно реализовать сложные функции с минимальным кодом и автоматически определять поведение взаимодействия с ботом на основе типа входящего контента.
• Лёгкий в освоении и мощный инструмент для создания изображений: можно визуально создавать простые 2D и сложные 3D изображения с помощью встроенного редактора сцен и использовать простой API для взаимодействия с плагинами и создания статических/динамических изображений.
• Гибкая система управления плагинами: поддерживает взаимодействие между плагинами, горячую перезагрузку, горячее редактирование и настройку зависимостей, а также встроенный плагин-редактор для быстрого создания и изменения плагинов.
• Гуманизированный интерфейс управления GUI: полностью китайский вывод отладочной информации и может легко реализовать взаимодействие между плагинами и GUI (например, пользовательский интерфейс GUI, пользовательские команды консоли и т. д.).
• Вспомогательные функции «из коробки»: не требуется работа с файлами для чтения и записи, можно легко инициализировать и управлять конфигурацией плагинов, данными плагинов, регистрацией событий/команд и т.д.
• Активное развитие функций и исправление проблем: активно разрабатываются новые функции и исправляются проблемы, и сообщество является движущей силой, широко принимая различные предложения и потребности, совместно создавая RainyBot для всех.

Начало работы

Пожалуйста, посетите онлайн-документацию RainyBot (https://docs.rainybot.dev), чтобы получить подробные инструкции по использованию RainyBot и документацию по каждому API.

Запуск из исходного кода

Если вы хотите успешно запустить RainyBot из исходного кода, убедитесь, что вы следуете следующим шагам:

• Используйте пользовательскую ветку Godot Engine 4.0 для RainyBot (https://github.com/Xwdit/godot/tree/rainybot), чтобы открыть этот проект.
• Поместите файлы Jar версии Mirai и Mirai Console v2.13.3, а также связанные файлы зависимостей в каталог adapters/mirai/libs, который находится в том же каталоге, что и исполняемый файл Godot Editor.
• Поместите файл Jar версии Mirai-Api-HTTP v2.7.1 в каталог adapters/mirai/plugins, который находится в том же каталоге, что и исполняемый файл Godot Editor.

В последней версии выпуска RainyBot эти файлы уже включены, поэтому дополнительная настройка не требуется. Если у вас возникнут проблемы при настройке этих файлов, вы можете напрямую скопировать папку adapters и её содержимое из последнего файла пакета выпуска и поместить их в тот же каталог, где находится исполняемый файл Godot Editor. Значительные улучшения и упрощение функций контекстного взаимодействия

• Совершенствование функций HTTP-запросов, поддержка большего количества типов запросов и ответов
• Реализация автоматического дополнения и проверки ошибок в редакторе плагинов
• Добавление функции обнаружения версии
• Создание онлайн-сообщества для плагинов
• Первоначальная поддержка сценариев загрузки плагинов для реализации визуализации изображений и создания графического интерфейса пользователя (GUI)
• Упрощение вызовов внутренних графических API
• Графическое представление дополнительных встроенных функций
• Добавление функций автоматического инкрементного обновления и автоматического исправления
• Планы по реализации узловой системы разрешений
• Поддержка использования командной системы через сообщения чата
• Поддержка одновременной работы нескольких учётных записей ботов

Для получения более подробной информации о функциональности, известных проблемах или предложениях по улучшению посетите страницу Issues в репозитории.

Руководство по внесению вклада

Мы очень благодарны за ваш интерес к участию в этом проекте и внесению улучшений. Для внесения вклада в код мы рекомендуем следовать следующему руководству:

1. Fork этого проекта в вашем репозитории
2. Создайте ветку для разрабатываемой функции или проблемы, которую вы хотите исправить (git checkout -b feature/AmazingFeature)
3. Зафиксируйте свои изменения (git commit -m 'добавление некоторых функций')
4. Отправьте свои изменения в ваш репозиторий (git push origin feature/AmazingFeature)
5. Откройте Pull Request в этом репозитории, чтобы мы могли увидеть и рассмотреть ваши изменения

Основанные проекты

Этот проект основан на следующих проектах, и при использовании этого проекта также следует учитывать их лицензии:

• Godot Engine (https://github.com/godotengine/godot)
• Mirai-Api-HTTP (https://github.com/project-mirai/mirai-api-http)
• Mirai (https://github.com/mamoe/mirai)

Лицензия проекта

Проект основан на лицензии AGPL-3.0. Подробности см. в файле LICENSE.

Контактная информация

QQ группа для общения: 881409193

Xwdit — xwditfr@gmail.com

Сообщество проекта: https://godoter.cn/t/rainybot

Открытый исходный код проекта: https://github.com/Xwdit/RainyBot-Core

Связанные ссылки

Здесь представлены некоторые ссылки, которые могут быть связаны с этим проектом или полезны для вас:

• Документация по использованию Godot (https://docs.godotengine.org/en/latest/)
• Учебное пособие по языку GDScript (https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/)
• Справочный API классов Godot (https://docs.godotengine.org/en/latest/classes/index.html)
• Документация Mirai-Api-Http (https://github.com/project-mirai/mirai-api-http/blob/master/docs/api/API.md)