RegionDisplay

English Version
# RegionName
**The Ultimate Region Visualization Solution for High-End Minecraft Servers.**

> "Don't just show the region name. Create an atmosphere."

## ✨ Overview
**RegionName** is a high-performance, professional-grade synchronization engine designed to provide players with seamless, real-time information about their location. Engineered for clarity and optimized for zero-impact on server TPS.

## Key Features
* ** Crystal Clear Display:** Automatic `BOLD` font injection and Hex-ready color support for maximum readability.
* **⚡ Ultra-Low Latency:** Asynchronous processing of HUD updates ensures your main thread stays at a perfect 20.0 TPS.
* ** Multi-Region Logic:** Sophisticated priority-based algorithm showing up to 3 overlapping regions in a single elegant line.
* ** Native Integration:** Full support for **WorldGuard**, **GriefPrevention**, and **PlaceholderAPI**.
* ** Sensory Feedback:** Customizable audio triggers upon entering or changing territories.
* ** Dynamic HUDs:** Simultaneous support for Persistent ActionBars and Interactive BossBars.

## Command System
| Command | Permission | Description |
| :--- | :--- | :--- |
| `/rn reload` | `regionname.admin` | Instant hot-reload of all configurations and lang files. |

## Permissions
* `regionname.admin` — Complete access to plugin management and update notifications.

## ⚙️ How It Works
1. **Detection:** Uses a lightweight block-boundary check to detect movement.
2. **Logic:** Scans all active region hooks (WG/GP) and sorts them by priority.
3. **Persistence:** Our proprietary `ActionBarTask` ensures the display never flickers or fades out, staying visible as long as the player is in the zone.
4. **Aesthetics:** Automatically applies `&l` formatting to maintain a bold, "premium" look across all versions (1.20.6 - 1.21+).

## Built-in Metrics
Powered by **bStats**, providing real-time analytics on language usage and feature popularity to help you optimize your player experience.

© 2026 **igalexor**. Built for performance. Designed for perfection.

Click to expand...

Русская версия
# RegionName
**Ультимативное решение для визуализации регионов на премиум-серверах Minecraft.**

> "Не просто показывайте название региона. Создавайте атмосферу."

## ✨ Обзор
**RegionName** — это высокопроизводительный движок профессионального уровня, разработанный для мгновенного информирования игроков о месте их нахождения. Создан для идеальной четкости и оптимизирован для нулевой нагрузки на TPS сервера.

## Ключевые особенности
* ** Кристальная четкость:** Автоматическое внедрение жирного шрифта `BOLD` и поддержка Hex-цветов для максимальной читаемости.
* **⚡ Нулевая нагрузка:** Асинхронная обработка обновлений HUD гарантирует стабильные 20.0 TPS без задержек.
* ** Умная логика:** Продвинутый алгоритм приоритетов, отображающий до 3-х наложенных регионов в одну элегантную строку.
* ** Нативная интеграция:** Полная поддержка **WorldGuard**, **GriefPrevention** и **PlaceholderAPI**.
* ** Сенсорный отклик:** Настраиваемые звуковые эффекты при входе или смене территории.
* ** Динамические HUD:** Одновременная поддержка постоянного Actionbar и интерактивного BossBar.

## Система команд
| Команда | Права (Permission) | Описание |
| :--- | :--- | :--- |
| `/rn reload` | `regionname.admin` | Мгновенная перезагрузка всех конфигов и языковых файлов. |

## Права доступа
* `regionname.admin` — Полный доступ к управлению плагином и уведомлениям об обновлениях.

## ⚙️ Как это работает
1. **Детекция:** Использует легковесную проверку границ блоков для отслеживания перемещений.
2. **Логика:** Сканирует все активные хуки (WG/GP) и сортирует их по приоритету.
3. **Стабильность:** Наш проприетарный `ActionBarTask` гарантирует, что текст никогда не мерцает и не исчезает, оставаясь видимым всё время.
4. **Эстетика:** Автоматическое применение форматирования `&l` для поддержания "дорогого" вида на всех версиях (1.20.6 - 1.21+).

## Встроенная метрика
Работает на базе **bStats**, предоставляя аналитику по использованию языков и популярности функций в реальном времени.

© 2026 **igalexor**. Создано для производительности. Разработано для совершенства.

Click to expand...

Developer API & Integrations
Enhance your plugin by connecting it with RegionName
​

1. Dependency (Maven)
Add the JAR to your project dependencies. If you don't have a private repo, install it to your local .m2 or use a system-scope dependency.

Code (XML):

<dependency>
    <groupId>me.igalexor </groupId>
    <artifactId>RegionName </artifactId>
    <version>1.0.0 </version>
    <scope>provided </scope>
</dependency>
 

Don't forget to add RegionName to your plugin.yml:

Code (YAML):

softdepend : [RegionName ]
 

2. Java API Example
The easiest way to get region data directly from the source.

Code (Java):

import me.igalexor.regionname.api.RegionNameAPI ;
import org.bukkit.entity.Player ;

public void handlePlayer (Player player ) {
    // Check if the player is standing in any tracked region
    if (RegionNameAPI. isInRegion (player ) ) {
        // Returns a List<String> of display names
        List <String > regions = RegionNameAPI. getPlayerRegions (player ) ;
        player. sendMessage ( "Welcome to " + regions. get ( 0 ) ) ;
    }
}
 

3. PlaceholderAPI
If you just need to display the location in other plugins (like Tab or Scoreboards), use our built-in placeholder:

• %regionname_current% — returns the current region(s) name or the "Wilderness" message.

Need help with API? Contact me via Discord​

Click to expand...