Create Custom ore ‐ Guide - DerFrZocker/Custom-Ore-Generator GitHub Wiki

How to Create a Custom Ore

1. Using the In-Game GUI (Minecraft 1.15+)

For Minecraft versions 1.15 and above, you can use the interactive in-game GUI. Simply type /oregen create and follow the on-screen prompts to define your ore configuration.

2. Using Commands (All Minecraft Versions)

For all Minecraft versions, you can create and manage ore configurations using commands. The plugin saves these configurations as YAML files in your server's plugins/CustomOreGenerator/ore-configs/ directory.

WARNING: Directly editing these YAML files is NOT RECOMMENDED unless you are 1000% sure about what you are doing. Incorrect modifications can corrupt your ore configurations. Always use the in-game commands or GUI for safe management.

Conceptual YAML Structure for an Ore Configuration:

# This is a simplified example of how an ore configuration looks in YAML.
# DO NOT directly create or modify files based on this unless you know exactly what you're doing.
value:
  ==: CustomOreGenerator#OreConfig
  name: my_custom_ore_name
  material: STONE
  ore-generator: VANILLA_MINABLE_GENERATOR
  block-selector: COUNT_RANGE
  activated: true
  generated-all: false
  replace-materials:
    - STONE
    - DIRT
  ore-settings:
    VEIN_SIZE: 8
  # ... other settings or custom data as applicable

Command-Line Steps:

Here are the general steps to create an ore configuration using commands:

  1. Create the basic ore configuration: /oregen create <name> <material> [<ore-generator>] [<block-selector>]

    • <name>: A unique identifier (alphanumeric, hyphens, underscores only).
    • <material>: The Minecraft block type (e.g., DIAMOND_ORE).
    • [<ore-generator>] (Optional): Defaults to VANILLA_MINABLE_GENERATOR.
    • [<block-selector>] (Optional): Defaults to COUNT_RANGE.
  2. Define replacement materials: /oregen set replace-material <ore-config> <material> ...

    • Specify which blocks your custom ore should replace (e.g., STONE, NETHERRACK).
  3. Configure ore settings: /oregen set value <ore-config> <setting> <value>

    • Adjust generator and block selector specific settings (e.g., VEIN_SIZE, MIN_HEIGHT). Refer to Settings for details.
  4. Add custom data (optional): /oregen set customdata <ore-config> <customdata> <value>

    • Apply advanced properties like NBT tags or block states. Refer to Customdata Overview for details.
  5. Add the ore configuration to a world: /oregen add ore-config <world> <ore-config> [<position>]

    • Enable generation in a specific world.

For detailed command usage and parameters, refer to the Commands page.

⚠️ **GitHub.com Fallback** ⚠️