region-events

region-events |

RegionEvents is a modern-plugin that manages when a player enters or leaves a WorldGuard region in their world. This plugin provides an API to work with players that are in a region, provide functions to search regions at a world or location, and listen to events when a player enters or leaves a region.

This plugin was made to run with Paper (or forks) on versions 1.21.1 and newer.

Features

• Listen to events when player enters or leaves a region.
• Provide useful functions to search possible regions at a specific world or location, or get the players that are in a region.
• Async, plugin uses an async-task to check by players' movements in/out of regions prior region's action's event firing.
• Easy to use.

Documentation

Plugin's code itself is already documented for a good understanding of what plugin does, and if another developers want to contribute, know where and how they can do it, either way, there's guides to know how to implement and use the Plugin's API classes, utilities and events.

• Plugin's API import; For plugin's API installation.
• API Instance Access; For know how to get a plugin's API instance.
• RegionHelper Usage; For summary of all the functions available for regions-management.
• Available Events; For plugin's available events.

Building

The plugin's dependency-manager structure uses Gradle-Kotlin and requires Java 21+ for compilement.

git clone [email protected]:aivruu/region-events
cd region-events
./gradlew shadowJar