docs: unify README style with flat-square badges and bilingual layout
This commit is contained in:
parent
80e610690a
commit
438518cef8
GPG key ID:
253067914055423B
1 changed files with 110 additions and 43 deletions
153
README.md
153
README.md
|
|
@ -1,61 +1,128 @@
|
|||
# Loreport
|
||||
<div align="center">
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
[](https://papermc.io/)
|
||||
[](https://adoptium.net/)
|
||||
# LoReport
|
||||
|
||||
Современная и производительная система репортов для Minecraft серверов с поддержкой Discord интеграции и интуитивным графическим интерфейсом.
|
||||
Modern player report system with Discord integration, GUI and database support for Paper servers.
|
||||
|
||||
## ✨ Возможности
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
- 📝 **Система репортов** - удобная отправка жалоб на нарушителей
|
||||
- 🎨 **Графический интерфейс** - интуитивный GUI для управления репортами
|
||||
- 📊 **Статистика и история** - детальная информация по каждому игроку
|
||||
- 🔔 **Discord интеграция** - мгновенные уведомления через webhook
|
||||
- 🗄️ **Поддержка БД** - SQLite для малых серверов, PostgreSQL для крупных
|
||||
- 🌐 **Локализация** - полностью настраиваемые сообщения
|
||||
- ⚡ **Оптимизация** - асинхронная работа с БД, минимальное влияние на TPS
|
||||
- 🔒 **Безопасность** - защита от SQL-инъекций, валидация данных
|
||||
[English](#english) | [Русский](#russian)
|
||||
|
||||
## 🚀 Быстрый старт
|
||||
</div>
|
||||
|
||||
1. Скачайте последнюю версию из [Releases](https://codeberg.org/loki5512344/Loreport/releases)
|
||||
2. Поместите `Loreport-x.x.x.jar` в папку `plugins/`
|
||||
3. Перезапустите сервер
|
||||
4. Настройте `plugins/Loreport/config.yml`
|
||||
---
|
||||
|
||||
## 📖 Документация
|
||||
<a name="english"></a>
|
||||
|
||||
Подробная документация доступна в папке [docs/](docs/):
|
||||
- [Команды и права](docs/commands.md)
|
||||
- [Конфигурация](docs/configuration.md)
|
||||
- [FAQ](docs/faq.md)
|
||||
- [API для разработчиков](docs/api.md)
|
||||
## English
|
||||
|
||||
## 🎯 Совместимость
|
||||
### Overview
|
||||
|
||||
- **Minecraft**: 1.19.2 - 1.21.11
|
||||
- **Серверное ПО**: Paper, Purpur, Pufferfish и другие Paper-форки
|
||||
- **Java**: 21+
|
||||
- **База данных**: SQLite 3.47+ или PostgreSQL 12+
|
||||
LoReport is a modern and performant player report system for Minecraft servers. It features an intuitive GUI, Discord webhook integration, statistics, and supports both SQLite and PostgreSQL databases.
|
||||
|
||||
## 🤝 Вклад в проект
|
||||
### Features
|
||||
|
||||
Мы приветствуем вклад в развитие проекта! Пожалуйста, ознакомьтесь с:
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md) - правила поведения
|
||||
- [Security Policy](SECURITY.md) - политика безопасности
|
||||
- [Contributing Guidelines](.github/PULL_REQUEST_TEMPLATE.md) - руководство по созданию PR
|
||||
| Feature | Description |
|
||||
|---------|-------------|
|
||||
| Report system | `/report <player> <reason>` with cooldown and limits |
|
||||
| GUI interface | Browse and manage reports in an inventory menu |
|
||||
| Player heads | Visual player identification in GUI |
|
||||
| Pagination | Navigate large report lists |
|
||||
| Statistics | Per-player report history and stats |
|
||||
| Discord integration | Instant webhook notifications with embeds |
|
||||
| SQLite | Zero-config database for small servers |
|
||||
| PostgreSQL | Scalable database for large servers |
|
||||
| Async database | All DB operations off the main thread |
|
||||
| Localization | Fully customizable messages |
|
||||
| SQL injection protection | All queries use PreparedStatement |
|
||||
| PlaceholderAPI | Report stats in other plugins |
|
||||
|
||||
## 🐛 Поддержка
|
||||
### Commands
|
||||
|
||||
- [Issues](https://codeberg.org/loki5512344/Loreport/issues) - сообщения об ошибках и предложения
|
||||
- [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) - вопросы и обсуждения
|
||||
- Email: loki@lokili.xyz
|
||||
| Command | Permission | Description |
|
||||
|---------|------------|-------------|
|
||||
| `/report <player> <reason>` | `lorep.report` | Report a player |
|
||||
| `/report gui` | `lorep.admin` | Open reports GUI |
|
||||
| `/report stats <player>` | `lorep.admin` | View player report stats |
|
||||
| `/rep` | `lorep.report` | Alias for /report |
|
||||
|
||||
## 📄 Лицензия
|
||||
### Dependencies
|
||||
|
||||
Этот проект распространяется под лицензией [GPL-3.0](LICENSE).
|
||||
- Required: Paper 1.19.2+, Java 21+
|
||||
- Optional: PlaceholderAPI
|
||||
- Database: SQLite 3.47+ (default) or PostgreSQL 12+
|
||||
|
||||
## 👨💻 Автор
|
||||
### Installation
|
||||
|
||||
Создано [loki5512344](https://codeberg.org/loki5512344)
|
||||
1. Drop the jar into `plugins/`
|
||||
2. Restart the server
|
||||
3. Configure Discord webhook in `plugins/Loreport/config.yml`:
|
||||
```yaml
|
||||
webhook-url: "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<a name="russian"></a>
|
||||
|
||||
## Русский
|
||||
|
||||
### Обзор
|
||||
|
||||
LoReport - современная и производительная система репортов для Minecraft серверов. Включает интуитивный GUI, Discord webhook интеграцию, статистику и поддержку SQLite и PostgreSQL.
|
||||
|
||||
### Возможности
|
||||
|
||||
| Возможность | Описание |
|
||||
|-------------|----------|
|
||||
| Система репортов | `/report <игрок> <причина>` с кулдауном и лимитами |
|
||||
| GUI интерфейс | Просмотр и управление репортами в меню |
|
||||
| Головы игроков | Визуальная идентификация в GUI |
|
||||
| Пагинация | Навигация по большим спискам |
|
||||
| Статистика | История репортов по каждому игроку |
|
||||
| Discord интеграция | Мгновенные уведомления через webhook с embed |
|
||||
| SQLite | Встроенная БД без настройки |
|
||||
| PostgreSQL | Масштабируемая БД для крупных серверов |
|
||||
| Асинхронная БД | Все запросы вне основного потока |
|
||||
| Локализация | Полностью настраиваемые сообщения |
|
||||
| Защита от SQL-иньекций | Все запросы через PreparedStatement |
|
||||
| PlaceholderAPI | Статистика репортов в других плагинах |
|
||||
|
||||
### Команды
|
||||
|
||||
| Команда | Право | Описание |
|
||||
|---------|-------|----------|
|
||||
| `/report <игрок> <причина>` | `lorep.report` | Отправить репорт |
|
||||
| `/report gui` | `lorep.admin` | Открыть GUI репортов |
|
||||
| `/report stats <игрок>` | `lorep.admin` | Статистика репортов игрока |
|
||||
|
||||
### Зависимости
|
||||
|
||||
- Обязательные: Paper 1.19.2+, Java 21+
|
||||
- Опциональные: PlaceholderAPI
|
||||
- База данных: SQLite 3.47+ (по умолчанию) или PostgreSQL 12+
|
||||
|
||||
### Установка
|
||||
|
||||
1. Положите jar в папку `plugins/`
|
||||
2. Перезапустите сервер
|
||||
3. Настройте Discord webhook в `plugins/Loreport/config.yml`:
|
||||
```yaml
|
||||
webhook-url: "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Links
|
||||
|
||||
- [Releases](../../releases)
|
||||
- [Issues](../../issues)
|
||||
- [License](LICENSE)
|
||||
|
||||
### License
|
||||
|
||||
GNU General Public License v3.0
|
||||
Loading…
Add table
Add a link
Reference in a new issue