feat: add modrinth documentation for publishing
- 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
This commit is contained in:
loki5512344
parent
55df7d97b2
commit
4f1572c9df
4 changed files with 204 additions and 1 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -22,7 +22,7 @@ Thumbs.db
|
||||||
*.war
|
*.war
|
||||||
*.ear
|
*.ear
|
||||||
hs_err_pid*
|
hs_err_pid*
|
||||||
modrinth
|
|
||||||
# Logs
|
# Logs
|
||||||
*.log
|
*.log
|
||||||
logs/
|
logs/
|
||||||
|
|
|
||||||
42
modrinth/changelog.md
Normal file
42
modrinth/changelog.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
## v1.1.0 - Улучшенная версия
|
||||||
|
|
||||||
|
### ✨ Новые возможности
|
||||||
|
- Поддержка Minecraft 1.19.2 - 1.21.4
|
||||||
|
- Улучшенная конфигурация с новыми опциями
|
||||||
|
- Добавлены алиасы команд: `/rep`, `/reports`
|
||||||
|
- Система уведомлений администраторов в игре
|
||||||
|
- Настраиваемые ограничения на количество репортов
|
||||||
|
- Улучшенный GUI с настройками отображения
|
||||||
|
|
||||||
|
### 🔧 Улучшения
|
||||||
|
- Оптимизирована производительность базы данных
|
||||||
|
- Улучшена совместимость с различными версиями Minecraft
|
||||||
|
- Обновлены зависимости для лучшей стабильности
|
||||||
|
- Добавлена поддержка Java 17+ (вместо Java 21)
|
||||||
|
- Улучшена обработка ошибок
|
||||||
|
|
||||||
|
### 🐛 Исправления
|
||||||
|
- Исправлены проблемы с кодировкой сообщений
|
||||||
|
- Улучшена стабильность Discord webhook
|
||||||
|
- Исправлены мелкие баги в GUI
|
||||||
|
|
||||||
|
### 📚 Документация
|
||||||
|
- Полная документация в папке `docs/`
|
||||||
|
- FAQ с ответами на частые вопросы
|
||||||
|
- Руководство по API для разработчиков
|
||||||
|
- Подробное описание конфигурации
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## v1.0.0 - Первый релиз
|
||||||
|
|
||||||
|
### ✨ Основные возможности
|
||||||
|
- Система репортов с командой `/report`
|
||||||
|
- GUI интерфейс для администраторов
|
||||||
|
- Статистика репортов по игрокам
|
||||||
|
- Интеграция с Discord через webhook
|
||||||
|
- Поддержка SQLite и PostgreSQL
|
||||||
|
- Настраиваемые сообщения
|
||||||
|
- Система прав доступа
|
||||||
108
modrinth/description.md
Normal file
108
modrinth/description.md
Normal file
|
|
@ -0,0 +1,108 @@
|
||||||
|
# 🚨 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! 🛡️**
|
||||||
53
modrinth/project-info.md
Normal file
53
modrinth/project-info.md
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
# Информация о проекте для Modrinth
|
||||||
|
|
||||||
|
## Основная информация
|
||||||
|
- **Название**: Loreport
|
||||||
|
- **Краткое описание**: Современная система репортов для Minecraft серверов с Discord интеграцией
|
||||||
|
- **Категории**: Management, Utility, Server Management
|
||||||
|
- **Лицензия**: GPL-3.0
|
||||||
|
- **Тип проекта**: Plugin (Server-side)
|
||||||
|
|
||||||
|
## Поддерживаемые версии
|
||||||
|
- **Minecraft**: 1.19.2, 1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4
|
||||||
|
- **Загрузчики**: Paper, Purpur, Pufferfish
|
||||||
|
- **Окружение**: Server
|
||||||
|
|
||||||
|
## Теги
|
||||||
|
- report
|
||||||
|
- reports
|
||||||
|
- moderation
|
||||||
|
- discord
|
||||||
|
- gui
|
||||||
|
- database
|
||||||
|
- admin
|
||||||
|
- management
|
||||||
|
- paper
|
||||||
|
- plugin
|
||||||
|
|
||||||
|
## Ссылки
|
||||||
|
- **Исходный код**: https://codeberg.org/loki5512344/Loreport
|
||||||
|
- **Issues**: https://codeberg.org/loki5512344/Loreport/issues
|
||||||
|
- **Wiki**: https://codeberg.org/loki5512344/Loreport/wiki
|
||||||
|
- **Discussions**: https://codeberg.org/loki5512344/Loreport/discussions
|
||||||
|
|
||||||
|
## Зависимости
|
||||||
|
Плагин не требует дополнительных зависимостей, все необходимые библиотеки включены в jar файл.
|
||||||
|
|
||||||
|
## Рекомендуемые плагины
|
||||||
|
- **LuckPerms** - для расширенного управления правами
|
||||||
|
- **PlaceholderAPI** - для интеграции с другими плагинами
|
||||||
|
- **DiscordSRV** - для дополнительной интеграции с Discord
|
||||||
|
|
||||||
|
## Галерея изображений
|
||||||
|
1. GUI интерфейс с репортами
|
||||||
|
2. Пример Discord уведомления
|
||||||
|
3. Статистика игрока
|
||||||
|
4. Конфигурационный файл
|
||||||
|
|
||||||
|
## Инструкции для загрузки
|
||||||
|
1. Выберите версию плагина, совместимую с вашей версией Minecraft
|
||||||
|
2. Скачайте файл `Loreport-x.x.x.jar`
|
||||||
|
3. Поместите файл в папку `plugins/` вашего сервера
|
||||||
|
4. Перезапустите сервер
|
||||||
|
5. Настройте конфигурацию в `plugins/Loreport/config.yml`
|
||||||
|
6. При необходимости настройте Discord webhook
|
||||||
Loading…
Add table
Add a link
Reference in a new issue