> For the complete documentation index, see [llms.txt](https://siriusatop123s-organization.gitbook.io/sirbonus-freedonate-plugindoc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://siriusatop123s-organization.gitbook.io/sirbonus-freedonate-plugindoc/readme.md).

# Welcome 1.20-1.21.4

Welcome to the **sirBonus** plugin documentation! This guide will walk you through everything you need to know about installing, configuring, and using the plugin on your Minecraft server.

### What is sirBonus?

**sirBonus** is a plugin designed to give players a chance to earn special donation-based privileges (like ranks or groups) once they meet certain conditions. It features:

* **Randomized group selection** with configurable chances.
* **Multi-language support** (English, Russian, French).
* **Cooldown** between attempts, ensuring players can’t spam the command.
* **One-time success limit** (a player can only successfully win once).
* **Persistent winners list**, so reloading or restarting the server won’t let them win again.

### Why Use sirBonus?

* **Encourage player engagement**: Offer a fun lottery-like system for players to get special ranks.
* **Fair distribution**: Control exactly how likely each rank is to be granted.
* **Seamless integration** with LuckyPerms for managing permissions.
* **Customizable experience** with sounds, titles, and messages.

### What’s in this Documentation?

1. **Installation & Setup**: Learn how to add the plugin to your server and integrate it with LuckyPerms.
2. **Configuration**: Explore `config.yml` and messages files to tailor the plugin to your needs.
3. **Command Usage**: See how players use `/freedonate` and how to handle permissions.
4. **Troubleshooting & FAQs**: Solve common problems and find helpful tips.

***

Continue to the next section to get started with **Installation & Setup**!\
\
\
**RU**

***

### Русский

Добро пожаловать в документацию по плагину **sirBonus**! В этом руководстве вы найдёте всю необходимую информацию об установке, настройке и использовании плагина на вашем Minecraft-сервере.

#### Что такое sirBonus?

**sirBonus** — это плагин, позволяющий игрокам получить донат-привилегии (например, ранги или группы) с определённой вероятностью и при соблюдении заданных условий. Ключевые особенности:

* **Случайный выбор группы** с настраиваемыми шансами.
* **Мультиязычная поддержка** (английский, русский, французский).
* **Кулдаун** между попытками, чтобы игроки не могли спамить команду.
* **Ограничение на один выигрыш** (игрок может успешно выиграть только один раз).
* **Сохранение списка победителей**, поэтому перезапуск сервера не даст игрокам выиграть повторно.

#### Зачем использовать sirBonus?

* **Увеличение вовлечённости игроков**: Предложите увлекательную систему «лотереи» для получения донат-рангов.
* **Честное распределение**: Вы контролируете вероятность выдачи каждого ранга.
* **Простая интеграция** с LuckyPerms для управления правами.
* **Гибкая настройка**: звуки, титулы и сообщения можно легко менять под свои нужды.

#### Что содержится в этой документации?

1. **Установка и настройка**: как добавить плагин на сервер и интегрировать его с LuckyPerms.
2. **Конфигурация**: настройка `config.yml` и файлов сообщений, чтобы адаптировать плагин к вашим потребностям.
3. **Использование команд**: как игроки используют `/freedonate` и как управлять правами доступа.
4. **Решение проблем и FAQ**: ответы на частые вопросы и подсказки.

***

Перейдите к следующему разделу, чтобы начать с **Установки и настройки**!