4f1572c9df
- Add modrinth/description.md with detailed project description - Add modrinth/changelog.md with version history - Add modrinth/project-info.md with publishing information - Fix .gitignore to include modrinth folder
108 lines
No EOL
5.5 KiB
Markdown
108 lines
No EOL
5.5 KiB
Markdown
# 🚨 Loreport - Современная система репортов
|
||
|
||
**Loreport** - это мощный и удобный плагин для Minecraft серверов, который предоставляет полноценную систему репортов с интеграцией Discord и красивым GUI интерфейсом.
|
||
|
||
## ✨ Основные возможности
|
||
|
||
### 📝 Простая система репортов
|
||
- Интуитивно понятная команда `/report <игрок> <причина>`
|
||
- Защита от спама репортов с настраиваемым кулдауном
|
||
- Ограничение на количество репортов на одного игрока
|
||
- Проверка длины причины репорта
|
||
|
||
### 🎨 Красивый GUI интерфейс
|
||
- Удобный интерфейс для просмотра всех репортов
|
||
- Отображение голов игроков для лучшей визуализации
|
||
- Пагинация для больших списков репортов
|
||
- Автообновление интерфейса
|
||
|
||
### 📊 Подробная статистика
|
||
- Команда `/report stats <игрок>` для просмотра статистики
|
||
- История всех репортов на игрока
|
||
- Информация о времени последнего онлайна
|
||
- Детальная информация о каждом репорте
|
||
|
||
### 🔔 Discord интеграция
|
||
- Автоматические уведомления в Discord через webhook
|
||
- Красиво оформленные сообщения с полной информацией
|
||
- Мгновенные уведомления администраторов о новых репортах
|
||
|
||
### 🗄️ Гибкая база данных
|
||
- **SQLite** - для небольших серверов, не требует настройки
|
||
- **PostgreSQL** - для больших серверов с высокой нагрузкой
|
||
- Автоматическое создание таблиц при первом запуске
|
||
- Оптимизированные запросы для высокой производительности
|
||
|
||
### 🌐 Полная настраиваемость
|
||
- Все сообщения можно изменить в конфигурации
|
||
- Поддержка цветовых кодов Minecraft
|
||
- Гибкие настройки ограничений и кулдаунов
|
||
- Настройка GUI и уведомлений
|
||
|
||
## 🎯 Совместимость
|
||
|
||
- **Minecraft версии**: 1.19.2 - 1.21.4
|
||
- **Серверное ПО**: Paper, Purpur, Pufferfish
|
||
- **Java**: 17+
|
||
- **Операционные системы**: Windows, Linux, macOS
|
||
|
||
## 🚀 Команды
|
||
|
||
| Команда | Описание | Права |
|
||
|---------|----------|-------|
|
||
| `/report <игрок> <причина>` | Отправить репорт на игрока | `lorep.report` |
|
||
| `/report gui` | Открыть GUI с репортами | `lorep.admin` |
|
||
| `/report stats <игрок>` | Статистика репортов игрока | `lorep.admin` |
|
||
|
||
**Алиасы**: `/rep`, `/reports`
|
||
|
||
## 🔐 Права доступа
|
||
|
||
- `lorep.report` - Отправка репортов (по умолчанию: все игроки)
|
||
- `lorep.admin` - Доступ к GUI и статистике (по умолчанию: операторы)
|
||
- `lorep.*` - Все права плагина
|
||
|
||
## ⚙️ Быстрая настройка
|
||
|
||
1. Скачайте плагин и поместите в папку `plugins/`
|
||
2. Перезапустите сервер
|
||
3. Настройте Discord webhook в `config.yml`:
|
||
```yaml
|
||
webhook-url: "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
|
||
```
|
||
4. При необходимости настройте базу данных PostgreSQL
|
||
5. Готово! Игроки могут использовать `/report`
|
||
|
||
## 📈 Производительность
|
||
|
||
Плагин оптимизирован для работы на серверах любого размера:
|
||
- Асинхронные операции с базой данных
|
||
- Кэширование часто используемых данных
|
||
- Минимальное влияние на производительность сервера
|
||
- Поддержка пула соединений для PostgreSQL
|
||
|
||
## 🛠️ Для разработчиков
|
||
|
||
Loreport предоставляет API для интеграции с другими плагинами:
|
||
- События для отслеживания новых репортов
|
||
- Методы для программного добавления репортов
|
||
- Интеграция с PlaceholderAPI
|
||
- Подробная документация API
|
||
|
||
## 🆘 Поддержка
|
||
|
||
- **Документация**: Полная документация включена в плагин
|
||
- **Issues**: [Codeberg Issues](https://codeberg.org/loki5512344/Loreport/issues)
|
||
- **Обсуждения**: [Codeberg Discussions](https://codeberg.org/loki5512344/Loreport/discussions)
|
||
|
||
## 📄 Лицензия
|
||
|
||
Проект распространяется под лицензией **GPL-3.0**, что означает:
|
||
- ✅ Свободное использование
|
||
- ✅ Изменение исходного кода
|
||
- ✅ Коммерческое использование
|
||
- ✅ Распространение
|
||
|
||
---
|
||
|
||
**Сделайте свой сервер безопаснее с Loreport! 🛡️** |