Библиотеки

Библиотеки - Набор компонентов, предоставляемый для нескольких расширений.

Отличие библиотек от ядра в том, что библиотеки не обязательны для работы бота, но они нужны для работы некоторых расширений.

Все библиотеки располагаются в директории libs/.

На этой странице будет представлено краткое описание каждой из встроенных библиотек. Вы сможете самостоятельно из изучить, просмотрев исходный код.

active_levels

Награда за активность участников. Измеряется общая активность каждого пользователя между всеми серверами.

Заметка

Данные сохраняются общие между всеми серверами.

В будущем это может быть исправлено.

Version: v2.2.2 (10)
Author: Milinuri Nirvalen
CLasses:
  - ActiveTable # Таблица активности пользователя
  - UserActive # Представление активности пользователя

channels

Хранилище именованных каналов бота. Обычно бот отвечает на сообщение в том же канале. где была использована команда. Но иногда бывает необходимость, когда боту самому нужно отправить сообщение. Эта библиотека используется для настройки каналов, в которые может писать бот

Version: v1.0 (3)
Author: Milinuri Nirvalen
Classes:
  - GuildChannel # Представление именованного канала на сервере
  - GuildChannels # Обёртка для управления каналами сервера как коллекцией
  - ChannelsTable # Таблица именованных каналов сервера

coinengine

Экономическая система. Предоставляет общую валюту между всеми пользователями бота.

Немного устарело

В ветке feat/puma готовится масштабное обновление для экономики. Вас ждёт:

• Курсы валют.
• Кредиты.
• Сберегательные счета.
• Работы.

Version: v2.2 (11)
Author: Milinuri Nirvalen
Classes:
  - UserCount # Представление баланса пользователя
  - CoinsTable # Таблица монет пользователей

inventory

Предоставляет API инвентаря пользователя. Он может хранить одинаковые исчисляемые вещи. К примеру мешки соли, дерево и все прочие ресурсы, что определены в индексе предметов.

Устаревшая библиотека

Она было написана для версии v0.5. Библиотека не соответствует современным стандартам и скоро будет переписана.

Version: v1.0 (12)
Author: Milinuri Nirvalen
Classes:
  - inventoryIndexError # Исключение при несоответствии предметов
  - Item # Представление предмета в индексе предметов
  - InventoryItem # Представление предмета в инвентаре пользователя
  - ItemIndex # Таблица индекса предметов
  - Inventory # Таблица инвентаря пользователя

profile

Профиль пользователя хранит некоторые числовые характеристики, связанные с пользователем.

Version: v1.2 (6)
Author: Milinuri Nirvalen
Classes:
  - UserProfile # Класс-обёртка для работы с профилем пользователя.
  - ProfileTable # Таблица профилей пользователя

role_shop

Магазин ролей для сервера. За основу использует экономическую систему.

Version: v1.0 (9)
Author: Milinuri Nirvalen
CLasses:
  - GuildRole # Роль, выставленная на продаваемая на сервере.
  - RoleShopTable # Таблица магазина ролей для сервера.

static_embeds

Предоставляет возможность создавать статические сообщения из файла.

Version: v.0 (1)
Author: Milinuri Nirvalen
Classes:
  - EmbedAuthor # Автор сообщения
  - EmbedField # Дополнительное поле сообщения
  - EmbedImage # Маленькое/большое сообщение embed
  - EmbedData # Представляет Embed сообщение.
  - StaticCommand # Описание статической команды.
  - StaticCommands # Хранилище статических команд.

timers

таймеры пользователя.

Таймеры используются чтобы временно блокировать действие некоторых операций.

Перенос в ядро

В скором времени может переместиться в функционал ядра. Если получит широкое распространение.

Version: v1.0 (1)
Author: Milinuri Nirvalen
CLasses:
  - UserTimer # Представление таймера пользователя
  - Timers # Хранилище таймеров пользователя

use_stat

Статистика использования бота. Отслеживает использование каждой команды пользователями.

Version: v1.2.1 (6)
Author: Milinuri Nirvalen
Classes:
  - CommandsUsage # Использование команды пользователем.
  - CommandsTable # Таблица использования команд пользователями.

voice_events

Представляет дополнительные события для голосового канала.

Version: v1.0 (4)
Author: Milinuri Nirvalen
Classes:
  - VoiceState # Состояние голосового канала в хранилище.
- VoiceEvent # Базовое событие голосового канала.
- UserVoiceEvent # Базовое событие, связанное с пользователем.
- GuildVoiceEvent # Базовое событие, связанное с сервером.
- UserStartVoice # Пользователь подключается к голосовому каналу.
- UserUpdateVoice # Пользователь обновляет своё состояние в голосовом канале.
- UserChangeVoice # Пользователь переходит в другой голосовой канал.
- UserEndVoice # Пользователь отключается от голосового канала.
- GuildStartVoice # На сервере начинается звонок.
- GuildUpdateVoice # на сервере обновляется статус голосового канала.
- GuildEndVoice # На сервере завершается звонок.
- VoiceStorage # Хранилище состояний голосовых каналов.