Skip to Content
Getting Started

Welcome to Oraxen docs

Looking for the old documentation? Visit the legacy GitBook site .

Are you an AI? Check /llms.txt or add .md to any page URL to get raw markdown and save tokens.

What Is Oraxen?

Oraxen is a Minecraft plugin which allows the creation of new items & blocks using custom textures and models. It also handles resourcepack generation, upload and storage (using Polymath), and is entirely open source with an extensible API.

How Does It All Work?

When a Spigot server starts with Oraxen installed, the plugin will read all the item configurations (your .yml files inside /plugins/oraxen/items) and use them to generate .json models that link your .png textures to your new items. After this, Oraxen zips the resources using an optimized algorithm and uploads it to a polymath instance. Polymath is a free and opensource software written in Python to host Minecraft resourcepacks. By default Oraxen will use an Oraxen supplied Polymath instance, hosted in Switzerland on an oracle virtual private server. Whenever a player connects to your server, Oraxen will link them to the polymath instance which then sends them the resourcepack.

Install Oraxen In Seconds!

Installing Oraxen is a fairly straight forward process:

  1. Drop the Oraxen .jar file into your /plugins/ folder.

  2. Restart your server.

Auto-Downloaded Dependencies

Oraxen automatically downloads required dependencies at runtime:

  • CommandAPI - Downloaded automatically for your server version
  • PacketEvents - Downloaded automatically with the correct version for your Minecraft setup

Optional Dependencies

That’s it! Although, we highly recommend heading into your settings.yml config and making any desired adjustments (then restarting once more) before continuing!

Oraxen has been tested with Spigot and Paper 1.18 -> 1.21.6 (Paper 1.21.11+ fully supported)

For Minecraft 1.21.2+, using the latest version of Oraxen is advised. Oraxen is developed and designed for use with Paper , Spigot , or Folia  server software. Download server jars from MCServerJars.com . For older Minecraft versions, start by installing Oraxen 1.183.0 to get compatible configuration files. You can then update the jar file accordingly.

Folia Support

Oraxen includes native support for Folia , PaperMC’s multithreaded server fork. On Folia servers, Oraxen automatically uses region-based and entity-based schedulers to ensure thread-safe operations. No additional configuration is required - Oraxen will detect Folia at startup and use the appropriate scheduling APIs.

Next Steps

Once installed, explore the documentation:

  • Creating Content - Create custom items, blocks, furniture, armors, and UI elements
  • Plugin Setup - Configure plugin settings, pack hosting, and more
  • Commands & Recipes - Learn the available commands and how to create recipes
  • Compatibility - Integrate with other plugins like MythicMobs, MMOItems, and world generators
Last updated on
FAQ