LoParkour/README.md
loki5512344 b6712391fd
fix(lint,command,scheduler): lpk alias, ReturnCount/IllegalCatch triage, scheduler facade
- command: replace /lp alias with /lpk (LuckPerms conflict, p.144);
  parkour alias kept; docs/changelog/javadoc updated
- lint p.169: restructure last 69 void early-returns into if-blocks and
  helpers; ReturnCount is now an error gate (0 violations)
- lint p.170: Throwable->RuntimeException on 3 boundaries; narrow 5
  catches to concrete types; document 14 intentional boundary catches
- scheduler p.21: add runTimerAsync to the facade (Bukkit + Folia
  backends); MetricsCacheStore and duels go through the facade, no
  BukkitRunnable/Bukkit.getScheduler outside scheduler/ (archunit
  freeze-store emptied); drop the unverified Folia badge from README
- tracker: mark p.26-29/32-33 done (fixed in fea15e6, verified)
2026-10-10 14:52:10 +02:00

134 lines
No EOL
5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
# LoParkour
Advanced infinitely generating parkour plugin with ghost system, leaderboards and multiple game modes.
![Java](https://img.shields.io/badge/Java-21+-orange?style=flat-square&logo=openjdk&logoColor=white)
![Paper](https://img.shields.io/badge/Paper-1.19.2+-blue?style=flat-square)
![License](https://img.shields.io/badge/license-GPLv3-blue?style=flat-square&logo=gnu&logoColor=white)
![version](https://img.shields.io/badge/version-1.4.0-green?style=flat-square)
[English](#english) | [Русский](#russian)
</div>
---
<a name="english"></a>
## English
### Overview
LoParkour is an advanced parkour plugin with infinite world generation. The course generates endlessly as you play, with multiple game modes, a ghost racing system, custom schematics, visual themes, and MySQL leaderboards.
### Features
| Feature | Description |
|---------|-------------|
| Infinite generation | Parkour generates endlessly as you play |
| Multiple game modes | Default, Speedrun, Gravity Shift, Elytra |
| Ghost system | Race against top player recordings |
| Custom schematics | Create and use your own parkour structures (.lpschem) |
| Visual themes | Customize block styles and particle effects |
| Leaderboards | Track high scores with MySQL or local storage |
| Rewards system | Configure rewards for score milestones |
| Multi-language | Full localization support (en, ru included) |
| PlaceholderAPI | Parkour stats in other plugins |
| Vault economy | Economy rewards support |
| Floodgate | Bedrock player support |
### Game Modes
| Mode | Description |
|------|-------------|
| Default | Classic infinite parkour |
| Speedrun | Blocks disappear after a few seconds |
| Gravity Shift | Random gravity effects (levitation, slow falling, jump boost) |
| Elytra | Fly through particle rings |
### Commands
| Command | Description |
|---------|-------------|
| `/lpk join` | Join parkour |
| `/lpk leave` | Leave parkour |
| `/lpk spectate <player>` | Spectate another player |
| `/lpk schematic save <name>` | Save a schematic |
| `/lpk schematic reload` | Reload schematics |
| `/lpk schematic convert` | Convert old vilib format |
| `/lpk forcejoin <player>` | Force player to join (admin) |
| `/lpk reset` | Reset leaderboards (admin) |
### Dependencies
- Required: Paper 1.19.2+, Java 21+
- Optional: PlaceholderAPI, Vault, HolographicDisplays, Floodgate, Multiverse-Core
### Installation
1. Drop the jar into `plugins/`
2. Restart the server
3. Configure `plugins/LoParkour/config.yml`
---
<a name="russian"></a>
## Русский
### Обзор
LoParkour - продвинутый паркур-плагин с бесконечной генерацией мира. Трасса генерируется по мере игры, с несколькими режимами, системой призраков, кастомными схематиками, визуальными темами и MySQL лидербордами.
### Возможности
| Возможность | Описание |
|-------------|----------|
| Бесконечная генерация | Паркур генерируется по мере игры |
| Несколько режимов | Default, Speedrun, Gravity Shift, Elytra |
| Система призраков | Гонка против записей топ-игроков |
| Кастомные схематики | Создавайте свои структуры (.lpschem) |
| Визуальные темы | Настройка стилей блоков и частиц |
| Лидерборды | Топ результатов через MySQL или локально |
| Награды | Настройка наград за достижение очков |
| Мультиязычность | Полная локализация (en, ru) |
| PlaceholderAPI | Статистика паркура в других плагинах |
| Vault | Экономические награды |
| Floodgate | Поддержка бедрок-игроков |
### Команды
| Команда | Описание |
|---------|----------|
| `/lpk join` | Начать паркур |
| `/lpk leave` | Выйти из паркура |
| `/lpk spectate <игрок>` | Наблюдать за игроком |
| `/lpk schematic save <имя>` | Сохранить схематику |
| `/lpk schematic reload` | Перезагрузить схематики |
| `/lpk forcejoin <игрок>` | Заставить игрока начать (админ) |
| `/lpk reset` | Сбросить лидерборды (админ) |
### Зависимости
- Обязательные: Paper 1.19.2+, Java 21+
- Опциональные: PlaceholderAPI, Vault, HolographicDisplays, Floodgate, Multiverse-Core
### Установка
1. Положите jar в папку `plugins/`
2. Перезапустите сервер
3. Настройте `plugins/LoParkour/config.yml`
---
### Links
- [Releases](../../releases)
- [Issues](../../issues)
- [License](LICENSE)
### License
GNU General Public License v3.0