# ArdaRegions<\/p>\n
Region discovery and tracking for Minecraft servers. Define regions on your map, let players discover them by exploring.<\/p>\n
## What it does<\/p>\n
**Regions**<\/p>\n
Define polygons in game. You can name them, add descriptions, set them to be discoverable, and set parent\/child links.<\/p>\n
**Discovery**<\/p>\n
When a player enters a region for the first time, it’s marked as discovered for the player, and they get a “DISCOVERED” popup. Player’s can also see their current location at the top left of the screen.<\/p>\n
**Map Types**<\/p>\n
Use your servers in-built BlueMap, or upload a Region Overlay to draw regions on.<\/p>\n
## Requirements<\/p>\n
– Minecraft 1.20.1
\n– Fabric Loader
\n– Fabric API
\n– Fabric Permissions
\n– BlueMap<\/p>\n
Optional
\n– LuckPerms<\/p>\n
## Setup<\/p>\n
### 1. Install on Server<\/p>\n
1. Add ArdaRegions jar to your servers `\/mods\/` directory
\n2. Start the server – the database and config will be created<\/p>\n
### 2. Install on Client<\/p>\n
1. Add ArdaRegions to your clients `\/mods\/` directory
\n2. Start your client<\/p>\n
### 3. Setting up the Map Tiles<\/p>\n
1. Install and run BlueMap, so it renders your world
\n2. On the server, run `\/ardaregions processtiles`. This will process BlueMap’s tiles into ArdaRegions tiles.
\n3. Optionally add an aditional Map Overlay to `config\/arda-regions\/map-overlay.json` on your client. Set the `worldSize` to the width of your image in Minecraft Blocks, and the `worldX` and `worldY` to the top left corner coordinates of your Minecraft World.
\n4. Switch between these maps by pressing the Map Overlay button in `\/ardaregions panel`<\/p>\n
### 4. Setting up Permissions<\/p>\n
ArdaRegions can use either the in-built Minecraft op permission system, or a permission system using the Fabric Permissions API, such as LuckPerms. <\/p>\n
If you are using LuckPerms, or another mod that implements the Fabric Permissions API, give the user the `ardaregions.admin` permission node to allow them to use Admin commands.<\/p>\n
## Commands<\/p>\n
– `\/ardaregions panel` \u2013 open the region map (admin). ## Credits<\/p>\n A massive thankyou to everyone who assisted in the development of this mod:<\/p>\n – Xone for beta-testing, bug-finding, and for making textures and graphics. ## API<\/p>\n ArdaRegions includes an API that allows other mods to utilise Regions events such as discovery, current region, region lists.<\/p>\n ### Getting the API<\/p>\n **Entrypoint (recommended):** “`json Your class implements `ArdaRegionsApiEntrypoint`:<\/p>\n “`java public class YourApiEntrypoint implements ArdaRegionsApiEntrypoint { **Or later:** —<\/p>\n ### Region API (`IRegionAPI`)<\/p>\n From `api.getRegionAPI()`.<\/p>\n | Method | Description | —<\/p>\n ### Exploration API (`IPlayerExplorationAPI`)<\/p>\n From `api.getExplorationAPI()`.<\/p>\n | Method | Description | —<\/p>\n ### Data types<\/p>\n **ApiRegion** **ApiPolygon** **ApiPoint2D** All are in package `mc.ardacraft.ardaregions.api.data`. Immutable.<\/p>\n —<\/p>\n ### Events<\/p>\n All are Fabric `Event | Event | Callback | When | Example:<\/p>\n “`java —<\/p>\n","protected":false},"excerpt":{"rendered":" Region management mod that allows you to assign names to custom polygons, and let users know where they are exploring.<\/p>\n","protected":false},"featured_media":18504,"template":"","meta":{"_minecraft_slug":"ardaregions","_minecraft_project_id":"m9rs3JWq","_minecraft_author":"ThomasApter","_minecraft_license":"LicenseRef-All-Rights-Reserved","_minecraft_downloads":94619,"_minecraft_follows":5,"_minecraft_client_side":"required","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"ardaregions.zip","_minecraft_size_bytes":3093733,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-17T00:25:39.805195Z","_minecraft_date_created":"2026-02-05T06:31:09.467224Z","_minecraft_date_modified":"2026-02-03T21:22:20.815688Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/ardaregions","_minecraft_icon_attachment_id":18504,"_minecraft_imported_at":"2026-05-31T20:03:37+00:00","_minecraft_import_hash":"c1a16d403cb49d50fef22c56864eb6f1","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,89,92],"mod_loader":[99],"minecraft_version":[36,60,93,94,101,102],"class_list":["post-18503","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-game-mechanics","mod_category-utility","mod_loader-fabric","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6"],"yoast_head":"\n
\n– `\/ardaregions processtiles` \u2013 process BlueMap tiles (admin).
\n– `\/ardaregions resetprogress` \u2013 reset your own discoveries.
\n– `\/ardaregions resetprogress
\n– `\/ardaregions view
\n– `\/ardaregions viewall` – view a 3d representation of all regions (admin).
\n– `\/ardaregions viewnone` – disable 3d representation view (admin).
\n– `\/ardaregions viewcurrent` – view current regions 3d representation (admin).<\/p>\n
\n– Fornad for beta-testing, bug-finding, and for being the first user.
\n– The entire ArdaCraft team for supporting the development of this project.
\n– Blue (BlueMap) for helping me utilise his mod’s tileset.<\/p>\n
\nIn `fabric.mod.json`:<\/p>\n
\n“entrypoints”: {
\n “arda-regions:api”: [
\n “your.mod.YourApiEntrypoint”
\n ]
\n}
\n“`<\/p>\n
\nimport mc.ardacraft.ardaregions.api.ArdaRegionsAPI;
\nimport mc.ardacraft.ardaregions.api.ArdaRegionsApiEntrypoint;<\/p>\n
\n @Override
\n public void onApiReady(ArdaRegionsAPI api) {
\n \/\/ Store api and use getRegionAPI() \/ getExplorationAPI() \/ events
\n }
\n}
\n“`<\/p>\n
\n`ArdaRegionsAPI.getInstance()` returns the API. Throws if the mod is not loaded. Prefer the entrypoint so you get the API as soon as it\u2019s ready.<\/p>\n
\n|——–|————-|
\n| `getRegion(String regionId)` | Region by ID, or empty |
\n| `getAllRegions()` | All regions |
\n| `getRegionsByWorld(String worldId)` | Regions in a world (world ID from registry key, e.g. `minecraft:overworld`) |
\n| `getChildRegions(String parentId)` | Direct children of a region |
\n| `getParentRegion(String regionId)` | Parent of a region, or empty |
\n| `regionExists(String regionId)` | True if the region exists |
\n| `isPointInRegion(String regionId, double x, double z, int y, String world)` | True if (x, z, y) in that world is inside the region |<\/p>\n
\n|——–|————-|
\n| `getDiscoveredRegions(UUID playerId)` | Set of discovered region IDs |
\n| `hasDiscovered(UUID playerId, String regionId)` | True if player has discovered that region |
\n| `getDiscoveryCount(UUID playerId)` | Number of regions discovered |
\n| `getDiscoveredRegionsAsObjects(UUID playerId)` | Discovered regions as `ApiRegion` objects |<\/p>\n
\n`id`, `name`, `parentId`, `childrenIds`, `polygons`, `metadata`.
\n`getDescription()` returns `metadata.get(“description”)` as string if present.<\/p>\n
\n`vertices` (list of `ApiPoint2D`), `minY`, `maxY`, `world`.
\n`isWithinYBounds(int y)` for Y check.<\/p>\n
\n`x`, `z` (double). Getters: `getX()`, `getZ()`.<\/p>\n
\n|——-|———-|——|
\n| `getRegionDiscoveredEvent()` | `(UUID playerId, String regionId)` | Player discovers a region |
\n| `getRegionCreatedEvent()` | `(ApiRegion region)` | Admin creates a region |
\n| `getRegionUpdatedEvent()` | `(ApiRegion oldRegion, ApiRegion newRegion)` | Admin updates a region |
\n| `getRegionDeletedEvent()` | `(String regionId)` | Admin deletes a region |
\n| `getClientDiscoveryPopupEvent()` | `(String regionId, String regionName, String description, float alpha)` | Client shows the discovery popup (client-side only) |<\/p>\n
\napi.getRegionDiscoveredEvent().register((playerId, regionId) -> {
\n \/\/ …
\n});
\n“`<\/p>\n