NxCodex

!Features

!Version !Paper

---

🗺️ 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.

---

!Commands

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 <name>	Creates a new zone
/codex delete <name>	Deletes an existing zone
/codex edit <name> <field> <value>	Edits a zone property
/codex editor <name>	Opens the GUI editor for a zone
/codex reload	Reloads the configuration
/codex reset	Resets all player discoveries

---

!Permissions

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

---

!Configuration

config.yml

prefix: '<gradient:#FCEF00:#FFF652><bold>Codex</bold></gradient> &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

menu:
  title: "<gradient:#FCEF00:#FFF652><bold>Codex</bold></gradient>"
  size: 54
  items:
    filler:
      material: "GRAY_STAINED_GLASS_PANE"
      slot: [0,1,2,3,4,5,6,7,8,9,17,18,26,27,35,36,44,45,53]
      name: " "
    locked_material:
      material: "BARRIER"
      name: "<gradient:#FCEF00:#FFF652><bold>Locked</bold></gradient>"
      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: "<gradient:#FCEF00:#FFF652><bold>Spawn</bold></gradient>"
      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: "<gradient:#8B0000:#FF0000><bold>Dark Dungeon</bold></gradient>"
      lore:
        - "&7A dangerous and mysterious place"
        - "&cRecommended level: 50+"
      cordinates:
        x: -500
        y: 30
        z: -500
        world: "world"
      region: "dark_dungeon"
      reward:
        commands:
          - "give %player_name% diamond_sword{Enchantments:[{id:sharpness,lvl:5}]} 1"
          - "eco give %player_name% 5000"

lang.yml

help:
  - '<gradient:#FCEF00:#FFF652><bold>Codex</bold></gradient> &7» &eHelp'
  - '&#27B7F5➤ &f/codex &7- Opens the Codex menu'
  - '&#27B7F5➤ &f/codex create <name> &7- Creates a new zone'
  - '&#27B7F5➤ &f/codex delete <name> &7- Deletes a zone'
  - '&#27B7F5➤ &f/codex edit <name> <field> <value> &7- Edits a zone'
  - '&#27B7F5➤ &f/codex list &7- Lists all zones'
  - '&#27B7F5➤ &f/codex reload &7- Reloads configuration'
  - '&#27B7F5➤ &f/codex reset &7- Resets all discoveries'
  - '&#27B7F5➤ &f/codex editor <name> &7- Opens zone editor'
  - '&#27B7F5➤ &f/codex help &7- Shows this help'

discovery:
  - '&eYou discovered the zone &f%name%&e!'
  - '&eReward:'
  - '&7%reward%'

teleport:
  success: '&aTeleported to zone &f%name%&a.'
  failed: '&cTeleportation failed. Check that the zone exists and the world is loaded.'

error:
  no-permission: '&cYou do not have permission to execute this command.'
  zone-not-found: '&cZone &f%name% &cdoes not exist.'
  cooldown: '&cPlease wait &f%time%s &cbefore teleporting again.'

Developed with ❤️ by NoxuWT