Minecraft plugin Codex

🔌 About the plugin Codex

Codex — is a Minecraft plugin that provides a journal-style GUI of "discoveries" players unlock while exploring the server. Codex adds RPG-flavored lore and a discoverable map of areas, mobs and events so servers can present world lore, rewards and teleport points.

🎯 Purpose

Codex solves the need to give players persistent lore and unlockable content without custom datapacks or large scripting. It is designed for servers that want a lightweight RPG/journal mechanic: discovery tracking, configurable GUI pages and reward actions.

⚙ Main features

• Create Discoveries with name, description and category. ()
• Multiple unlock methods: entering WorldGuard regions, killing vanilla mobs, killing MythicMobs mobs, or via console/commands. ()
• Reward actions on unlock: messages, sounds, titles and console commands. ()
• Configurable GUI inventories with custom items and multiple pages. ()
• Date-of-unlock tracking and click actions on unlocked discoveries. ()
• PlaceholderAPI variables and MySQL support (configurable). ()

🧩 Who it fits

Codex fits servers that want:

• RPG / Adventure servers that expose lore and areas.
• Survival servers that want discovery rewards or teleport GUI.
• Servers using MythicMobs or region plugins to tie discoveries to gameplay.

🏗 Example uses

• Players unlock a region discovery on first entry; unlock triggers a welcome message and gives a reward.
• A locked zone appears in the Codex GUI until the player discovers it; clicking an unlocked zone teleports the player (with configurable delay).
• Server admins create questlike areas and give cosmetic or economy rewards through reward commands.

⌨️ Commands

(Commands listed are confirmed in official resources). ()

🔐 Permissions

(Permissions confirmed in Spigot/Modrinth listings; some nodes may vary by version). ()

⚙ Installation

📥 Install

• Download the Codex .jar from an official source (Spigot/Modrinth). ()
• Place the .jar in your server plugins/ folder.
• Restart the server (do not rely on /reload).
• Confirm the plugin creates /plugins/Codex/ and configuration files.

📦 Dependencies

• PlaceholderAPI — confirmed support for placeholders. ()
• MySQL — Codex supports saving to MySQL when configured. ()
• HeadDatabase — supported by variants or similar forks (seen on a Modrinth variant). Use only if your setup lists it as required. ()

Only list dependencies that are present in official pages; no other implicit dependencies were confirmed.

🧾 Configuration

• Codex generates a config folder and configuration files on first run. ()
• The plugin is highly configurable: discoveries, inventories, messages, and reward commands are editable in config/YAML.
• MySQL connection parameters are available in config if you opt to use MySQL storage. ()

🧠 Additional information

Known conflicts

• Official sources do not list specific plugin conflicts. As with any plugin that hooks events or commands, test for overlaps with other GUI/command or region plugins in your environment. ()

Limitations

• Supported platforms: Paper / Purpur / Spigot (confirmed). Game versions confirmed on Modrinth: 1.16.5–1.21.8; Spigot notes "works on 1.16.5+". Verify the version compatibility for the release you install. ()
• No explicit proxy (Bungee/Velocity) multi-server support is documented in official pages.

FAQ

Q: Where do discoveries come from? A: Discoveries are created in config and can be unlocked by regions, mob kills, NPC interactions or console commands. ()

Q: Does Codex store data in MySQL? A: Yes — MySQL support is documented; enable/configure it in the plugin config. ()

Q: Is there a wiki or documentation? A: Yes — the plugin author provides a GitBook wiki with tutorials and config examples (linked from the official resource pages). ()

Q: Does Codex use bStats? A: bStats usage is not mentioned in the official sources consulted. Information absent in official pages. ()

Q: Is there Discord support? A: The Spigot resource lists a community Discord (community support). Official author support is primarily via Spigot/Modrinth discussions and the GitBook wiki. ()

Sources: official Spigot resource and Modrinth plugin pages and their linked documentation. ()