NxCodex

!(https://cdn.modrinth.com/data/cached_images/caef94d5391fd0d5819c123326d791ce4a9c479b.png)

!(https://img.shields.io/badge/Version-1. 2. 0-blue) !(https://img.shields.io/badge/Paper-1. 16%2B-brightgreen) [!(https://img.shields.io/discord/1463533838704578645?logo=discord&label=Discord&color=5865F2)](https://discord.com/invite/ydn5S7FC7q)

🗺️ Zone Discovery System: Players automatically discover zones by entering WorldGuard regions and receive custom rewards.

🎨 Fully Configurable GUI: Beautiful gradient-based menu with locked/unlocked zones, custom items and HeadDatabase support.

📊 Player Progress Tracking: Persistent database storage (H2, SQLite or MySQL) tracks all player discoveries.

⏱️ Smart Cooldown System: LuckPerms group-based teleportation cooldowns with admin bypass.

🔧 Rich Integrations: WorldGuard regions, WorldEdit, LuckPerms groups, ItemsAdder and HeadDatabase.

🎮 In-Game Zone Editor: Create, edit and delete zones directly from an intuitive GUI without touching config files.

💾 Multi-Database Support: Choose between H2 (embedded), SQLite or MySQL for your server needs.

🎨 Gradient & Hex Colors: Full support for color gradients and hex colors in all messages and menus.

🔄 Update Notifier: Automatically checks for new versions and notifies admins on join.

!(https://cdn.modrinth.com/data/cached_images/431ec5c9aaecaf04589a244c37757f31cb7f14e8.png)

### Player Commands

| Command | Description | | ------- | ----------- | | `/codex` | Opens the main Codex menu | | `/codex help` | Shows command help | | `/codex stats` | View your discovered zones | | `/codex list` | Lists all available zones |

### Admin Commands

| Command | Description | | ------- | ----------- | | `/codex create ` | Creates a new zone | | `/codex delete ` | Deletes an existing zone | | `/codex edit ` | Edits a zone property | | `/codex editor ` | Opens the GUI editor for a zone | | `/codex reload` | Reloads the configuration | | `/codex reset` | Resets all player discoveries |

!(https://cdn.modrinth.com/data/cached_images/9ea72e5de8071d444971a01defe09719f01bd476.png)

| Permission | Description | Default | | ---------- | ----------- | ------- | | `codex.use` | Use player commands | `true` | | `codex.view` | View discovered zones | `true` | | `codex.list` | List all zones | `true` | | `codex.create` | Create zones | `op` | | `codex.edit` | Edit zones | `op` | | `codex.delete` | Delete zones | `op` | | `codex.admin` | All admin permissions | `op` | | `codex.reset` | Reset all discoveries | `op` |

!(https://cdn.modrinth.com/data/cached_images/0266b89f6ed95c8764676c24119d5fe9f2a82fec.png)

### config.yml

```yaml prefix: 'Codex &7» '

database: # h2, sqlite or mysql type: h2 # H2 / SQLite settings (file-based) file: codex # MySQL settings (only used when type: mysql) host: localhost port: 3306 name: nxcodex username: root password: ''

private-games: enabled: true password-length: 4

number-formatting: mode: 0 # 0 = formatted (1,000), 1 = short (1K), 2 = raw (1000. 00) formatted: '#,###.##' short: en_US

update-notifier: enabled: true on-join: true

integration: itemsadder: enabled: true plugin: "ItemsAdder" head-database: enabled: true plugin: "HeadDatabase"

teleportation: # LuckPerms group-based cooldowns enabled: true cooldown: default: 5 # seconds admin: 0 vip: 3 # custom group example ```

### codex.yml

```yaml menu: title: "Codex" size: 54 items: filler: material: "GRAY_STAINED_GLASS_PANE" slot: name: " " locked_material: material: "BARRIER" name: "Locked" lore: - "&7This zone is locked." - "&7You cannot access it yet."

codex: zone: spawn: slot: 10 material: "GRASS_BLOCK" # custom-model-data: 1234 # Optional # hdb: "12345" # HeadDatabase ID name: "Spawn" lore: - "&7The main spawn point." - "&7Click to teleport." cordinates: x: 0 y: 64 z: 0 world: "world" region: "spawn_region" # WorldGuard region reward: commands: - "give %player_name% diamond 5" - "eco give %player_name% 1000" dungeon: slot: 11 material: "NETHERITE_SWORD" name: "Dark Dungeon" lore: - "&7A dangerous and mysterious place" - "&cRecommended level: 50+" cordinates: x: -500 y: 30 z: -500 world: "world" region: "dark_dungeon