Configuration

MrUltimateGenerators features a modular configuration layout split into several files. Below you will find the main settings file as well as custom setups for creating generators and boosters.

1. Core settings (engine.yml)

This file defines basic engine parameters, SQL database links, languages, and debug logging options.

engine.yml

MrUltimateGenerators:
  Engine:
    Language: english
    Prefix: "{#ff0000>}MRULTIMATEGENERATORS{#eb0000<}&8 » &f"
    Holograms:
      Provider: MrUltimateLibrary
      Refresh: 20
    PlayerData: 
      Method: YML
      SQLite:
        FileName: UltimateGenerators.db
      MySQL:
        address: 0.0.0.0
        port: 3306
        database: "MrUltimateGenerators"
        username: "mrUltimateGenerators_user"
        password: "VeryStrongPassword"
    Debugs:
      Enabled: false
      Types:
        GenerationTask: true
        Holograms: true
        Database: true
        Events: true
    ConfigManager:
      AllowAutoEditConfigs: true
      Files:
        - "config.yml;1.0.0;global"
        - "generatormenu.yml;1.0.0;global"
        - "generators.yml;1.0.0;global"
        - "messages.yml;1.0.0;global"
        - "shopmenu.yml;1.0.0;global"
        - "boosters.yml;1.0.0;global"
        - "events.yml;1.0.0;global"

2. How to Add a Generator (generators.yml)

To create a custom generator block, add a new entry under MrUltimateGenerators.Generators in generators.yml. You must specify the block item type, upgrade levels, evolutions (to transition to higher tier generator blocks), individual drops with percentage chances, and hologram settings:

generators.yml (Example)

MrUltimateGenerators:
  Generators:
    WHEAT:
      Settings:
        Name: "{#ff0000>}Wheat Generator{#eb0000<}"
        Item: HAY_BLOCK          # block placed in the world
        BuyPrice: 500
        Timer: 30                # drop tick timer in seconds
        BreakChance: 5.0         # % chance to become corrupted on drop
        ShowInShop: true
        Evolution:
          Next: MELON            # evolve into melon generator
          Price: 2500
      Levels:
        2:
          UpgradePrice: 1500
          Timer: 25              # upgraded block speeds up to 25s
      Drops:
        '1':
          Amount: 1
          Chance: 80             # 80% chance to drop Wheat
          SellPrice: 50
          Item:
            Material: WHEAT
            Name: "&eWheat Drop (Tier I)"
        '2':
          Amount: 1
          Chance: 20             # 20% chance to drop Premium Wheat
          SellPrice: 750
          Item:
            Material: WHEAT
            Glowing: true
            Name: "&6Wheat Drop (Tier II)"
      Hologram:
        Type: Fixed2             # motionless hologram visible from both sides
        YLevel: -0.15            # height adjustment relative to block
        Lines:
          - '#ITEM:WHEAT'        # Floating wheat item
          - ''
          - '#Settings:TextSize:1.25 &eWheat Gen'
          - '&7Next drop in: [TimeLeft]s'

3. How to Create a Booster (boosters.yml)

Boosters are items that players can consume (via right-click) to speed up generator generation times or increase sell prices. Register booster types under MrUltimateGenerators.Boosters inside boosters.yml:

boosters.yml (Example)

MrUltimateGenerators:
  Boosters:
    SPEED_2_0:
      Head:
        Type: SPEEDBOOST        # SPEEDBOOST, SELLBOOST, or DOUBLE_DROPS
        Multiplier: 2.0         # speed multiplier factor
        Duration: 1800          # active duration in seconds (30 minutes)
        Stackable: true         # duration stacks if multiple consumed
      Item:
        Material: SUGAR
        Glowing: true
        Name: "&bSpeed Booster (2.0x)"
        Lore:
          - "&7Right-click to speed up generator ticks by 2.0x!"