diff --git a/README.md b/README.md new file mode 100644 index 0000000..04e6d99 --- /dev/null +++ b/README.md @@ -0,0 +1,128 @@ +
` | Authenticate with a verification code |
+
+### Architecture
+
+```
+LoAuth/
+├── common/ - Shared code between modules
+├── discord/ - JDA Discord bot
+└── plugin/ - Paper plugin (main module)
+```
+
+### Dependencies
+
+- Required: Paper 1.19.2+, Java 21+, Discord bot token
+- Optional: PlaceholderAPI
+
+### Installation
+
+1. Drop the jar into `plugins/`
+2. Configure Discord bot token in `plugins/LoAuth/config.yml`
+3. Restart the server
+4. Invite the Discord bot to your server
+
+---
+
+
+
+## Русский
+
+### Обзор
+
+LoAuth - плагин авторизации с привязкой к Discord. Игроки подтверждают личность через Discord-бота для входа на сервер, связывая Minecraft-аккаунт с Discord-аккаунтом.
+
+### Возможности
+
+| Возможность | Описание |
+|-------------|----------|
+| Верификация через Discord | Привязка Minecraft-аккаунта к Discord через бота |
+| Защита входа | Только верифицированные игроки могут войти |
+| Роли Discord | Разные роли Discord дают разные права |
+| Интеграция с ботом | Встроенный JDA Discord-бот |
+| Реакции для входа | Подтверждение входа реакцией в Discord |
+| Мульти-модульность | Common, Discord-бот и Paper-плагин |
+| Настройка | Полный контроль над процессом авторизации |
+
+### Команды
+
+| Команда | Описание |
+|---------|----------|
+| `/login <код>` | Авторизация с кодом верификации |
+
+### Архитектура
+
+```
+LoAuth/
+├── common/ - Общий код между модулями
+├── discord/ - JDA Discord-бот
+└── plugin/ - Paper плагин (основной)
+```
+
+### Зависимости
+
+- Обязательные: Paper 1.19.2+, Java 21+, токен Discord-бота
+- Опциональные: PlaceholderAPI
+
+### Установка
+
+1. Положите jar в папку `plugins/`
+2. Настройте токен Discord-бота в `plugins/LoAuth/config.yml`
+3. Перезапустите сервер
+4. Пригласите Discord-бота на свой сервер
+
+---
+
+### Links
+
+- [Releases](../../releases)
+- [Issues](../../issues)
+- [License](LICENSE)
+
+### License
+
+GNU General Public License v3.0
\ No newline at end of file