Oraxen
  • Getting started
  • Frequently Asked Questions
  • Usage
    • Commands
    • Default items
    • Recipes
  • Configuration
    • Understanding the basics
    • Plugin settings
    • Items (beginners)
    • Items (advanced)
      • Dyeable Items
    • Custom Armors
      • Component Based (1.21.2+)
      • Trims Based (1.20-1.21.1)
      • Shader Based (1.18-1.19.4)
    • Custom HUD
    • Item Appearance
    • Glyphs
      • Custom Gui
  • Mechanics
    • Introduction
    • All mechanics
      • Custom mechanic
      • clickAction Mechanic
    • Furniture Mechanic
      • Furniture Position
      • Display-Entity Furniture
      • Farming Mechanic
    • NoteBlock mechanic
      • Stripped log Mechanic
      • Directional mechanic
      • Farmblock Mechanic
    • StringBlock Mechanic
      • Sapling Mechanic
  • Compatibility
    • BossShopPro - shop
    • CrateReloaded - crates
    • ModelEngine - custom mobs
    • MythicMobs - custom mobs
    • TrMenu - custom inventories
    • MMoItems
    • MythicCrucible
    • HappyHUD
    • World Generators
      • Iris World Generator
      • EpicWorldGenerator
      • Custom Ore Generator
      • RealisticWorldGenerator
  • Vendors
    • Vendor Guidelines
  • Developers
    • Create your own Mechanic
    • Add Compatibility with a plugin
    • Custom hosting service
    • API
Powered by GitBook
On this page
  • Color and other minecraft formatting
  • Content of the Oraxen folder
  • Global configurations
  • Items configurations
  • Resourcepack
  • Recipes

Was this helpful?

  1. Configuration

Understanding the basics

A simple explanation of how oraxen works

PreviousRecipesNextPlugin settings

Last updated 9 months ago

Was this helpful?

As seen previously, Oraxen is able to generate custom items including the texture pack that goes with them. It also makes it possible to associate these items with special powers or capabilities known as mechanics.

Color and other minecraft formatting

Minecraft only supported 16 colors in the past and most plugins used a special format with the & character. However, 1.16 added hex coloring for text and given the amount of formatting possible (clickable messages for example). Since PaperMC supports the . You are able to use hex coloring for items as well as some other additional tricks. If you'd like to try out minimessage formatting, !

Examples:

  • Hex Colors - <#FF5555>I start out red <#55FF55>and now im green!

  • Simple Colors - <green>I'm green <gold>now I'm golden</gold> now I'm green again!

  • Auto Gradient - <gradient:red:green:blue>This example automatically applies a gradient to whatever is between the start and end of the gradient</gradient>

Content of the Oraxen folder

Global configurations

At root of this configuration folder you'll find two files: settings.yml which contains various settings for Oraxen and mechanics.yml which contains global mechanics settings.

Items configurations

The subfolder Oraxen/items contains all created/purchased item configurations. You may make a new file for any item(s) you'd like or remove existing ones. While everything can be in a single file, storing them in folders with explicit names should help keep things organized

Resourcepack

The resource pack is a crucial element of oraxen and even if it is able to generate most of the files you will need, you will still have to provide the textures of the custom items yourself, all this is managed inside the Oraxen/pack folder.

You can use the Oraxen/pack/textures subfolder for adding textures and the Oraxen/pack/models subfolder for adding models (if you want to use 3d items for example). You can also change the basic files of the pack (pack.mcmeta, pack icon, etc.) from the Oraxen/pack folder itself.

If you need to override a specific file from oraxen, you can create the Oraxen/pack/assets folder and insert for example assets/minecraft/sounds.json to override that file if generated by oraxen.

Recipes

This folder contains the different recipe configurations you have added which are sorted by recipe type. For example, Oraxen/recipes/shaped.yml will contain all shaped recipes while Oraxen/recipes/campfire.yml will have any campfire recipes.

This folder is rarely touched because it is easier/faster to generate recipe configs directly from the game via the .

oraxen recipe command
MiniMessage format
click here
Page cover image
image
Directory tree structure of Oraxen folder