feat: major update v1.1.0 - improved documentation, configuration and compatibility
- Add comprehensive documentation in docs/ folder - Update README.md with modern design and badges - Improve configuration with new options (GUI, limits, notifications) - Add support for Minecraft 1.19.2-1.21.4 and Java 17+ - Create GPL-3.0 license - Add modrinth/ folder with project description for publishing - Add CONTRIBUTING.md for contributors - Update plugin.yml with aliases and better permissions - Improve build.gradle.kts with better compatibility and encoding - Update .gitignore for cleaner repository
This commit is contained in:
parent
da356e491c
commit
55df7d97b2
14 changed files with 1582 additions and 73 deletions
108
docs/faq.md
Normal file
108
docs/faq.md
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
# Часто задаваемые вопросы (FAQ)
|
||||
|
||||
## Установка и настройка
|
||||
|
||||
### Q: Плагин не загружается, что делать?
|
||||
A: Проверьте:
|
||||
- Версию Java (требуется 17+)
|
||||
- Версию сервера (Paper 1.19.2+)
|
||||
- Логи сервера на наличие ошибок
|
||||
- Правильность названия файла плагина
|
||||
|
||||
### Q: Как настроить Discord уведомления?
|
||||
A:
|
||||
1. Создайте webhook в настройках Discord канала
|
||||
2. Скопируйте URL webhook
|
||||
3. Вставьте его в `config.yml` в поле `webhook-url`
|
||||
4. Перезагрузите плагин командой `/reload confirm`
|
||||
|
||||
### Q: Какую базу данных выбрать?
|
||||
A:
|
||||
- **SQLite** - для серверов до 100 игроков, не требует настройки
|
||||
- **PostgreSQL** - для больших серверов, лучшая производительность
|
||||
|
||||
## Использование
|
||||
|
||||
### Q: Игроки не могут отправлять репорты
|
||||
A: Проверьте права доступа:
|
||||
- Убедитесь что у игроков есть право `lorep.report`
|
||||
- Проверьте настройки плагина прав (LuckPerms, PermissionsEx и т.д.)
|
||||
|
||||
### Q: GUI не открывается
|
||||
A: Проверьте:
|
||||
- Есть ли у вас право `lorep.admin`
|
||||
- Нет ли ошибок в консоли
|
||||
- Правильно ли настроена база данных
|
||||
|
||||
### Q: Как удалить репорт?
|
||||
A: В текущей версии удаление репортов через игру не поддерживается. Можно удалить напрямую из базы данных или ждать следующего обновления.
|
||||
|
||||
### Q: Можно ли изменить сообщения плагина?
|
||||
A: Да, все сообщения настраиваются в секции `messages` файла `config.yml`.
|
||||
|
||||
## Производительность
|
||||
|
||||
### Q: Плагин тормозит сервер
|
||||
A:
|
||||
- Переключитесь на PostgreSQL если используете SQLite
|
||||
- Увеличьте `pool-size` в настройках PostgreSQL
|
||||
- Проверьте логи на ошибки подключения к БД
|
||||
|
||||
### Q: Discord уведомления не приходят
|
||||
A: Проверьте:
|
||||
- Правильность URL webhook
|
||||
- Доступность Discord API с вашего сервера
|
||||
- Логи плагина на наличие ошибок
|
||||
|
||||
## Совместимость
|
||||
|
||||
### Q: Работает ли с Spigot?
|
||||
A: Нет, плагин требует Paper API. Используйте Paper, Purpur или Pufferfish.
|
||||
|
||||
### Q: Поддерживается ли версия 1.18?
|
||||
A: Нет, минимальная поддерживаемая версия - 1.19.2.
|
||||
|
||||
### Q: Работает ли с другими плагинами репортов?
|
||||
A: Плагин независим, но может конфликтовать с другими системами репортов. Рекомендуется использовать только один плагин репортов.
|
||||
|
||||
## Разработка
|
||||
|
||||
### Q: Есть ли API для других плагинов?
|
||||
A: Да, смотрите [документацию API](api.md).
|
||||
|
||||
### Q: Как собрать плагин из исходников?
|
||||
A:
|
||||
```bash
|
||||
git clone https://codeberg.org/loki5512344/Loreport.git
|
||||
cd Loreport
|
||||
./gradlew shadowJar
|
||||
```
|
||||
Готовый jar будет в папке `build/libs/`.
|
||||
|
||||
### Q: Как сообщить об ошибке?
|
||||
A: Создайте issue на [Codeberg](https://codeberg.org/loki5512344/Loreport/issues) с подробным описанием проблемы и логами.
|
||||
|
||||
## Миграция
|
||||
|
||||
### Q: Как перенести данные с другого плагина репортов?
|
||||
A: В текущей версии автоматическая миграция не поддерживается. Обратитесь к разработчику для помощи с миграцией.
|
||||
|
||||
### Q: Как сделать бэкап репортов?
|
||||
A:
|
||||
- **SQLite**: скопируйте файл `plugins/Loreport/reports.db`
|
||||
- **PostgreSQL**: используйте `pg_dump` для создания бэкапа базы данных
|
||||
|
||||
## Поддержка
|
||||
|
||||
### Q: Где получить помощь?
|
||||
A:
|
||||
- [Issues](https://codeberg.org/loki5512344/Loreport/issues) - для багов
|
||||
- [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) - для вопросов
|
||||
- Discord сервер разработчика (ссылка в профиле)
|
||||
|
||||
### Q: Планируются ли новые функции?
|
||||
A: Да! Планируется:
|
||||
- Веб-панель для управления репортами
|
||||
- Система категорий репортов
|
||||
- Автоматические действия (бан, кик)
|
||||
- Интеграция с другими плагинами модерации
|
||||
Loading…
Add table
Add a link
Reference in a new issue