MineWorlds icon

MineWorlds -----

Individual and optimized mining, fast and easy mining.

Download Now
Via external site


⛏ MineWorlds Documentation ⛏
Complete Configuration & Usage Guide
Version 1.0.1​



Table of Contents

  1. Commands & Permissions
  2. Configuration Guide
  3. World Settings
  4. Time & Cooldown System
  5. Return World Configuration (NEW)
  6. Special Ores Configuration
  7. VIP Features
  8. Multi-Language Setup
  9. Troubleshooting



1. Commands & Permissions

Commands

Code (Text):

/mine [overworld|nether]
  Description: Create and enter a mining world
  Permission: mineworlds.use
  Aliases: /mineworld, /mw
  Usage Examples:
    /mine              - Opens GUI to select world type
    /mine overworld    - Direct access to overworld mining
    /mine nether       - Direct access to nether mining

/leavemine
  Description: Exit mining world and return to main world
  Permission: mineworlds.use
  Aliases: /leavemining, /exitmine, /minexit
  Usage: /leavemine

/history mine
  Description: View your mining world history
  Permission: mineworlds.history
  Aliases: /hist, /minehistory
  Usage: /history mine
  Note: VIP players can click worlds to revisit them
 
Permissions

Code (Text):

mineworlds.use
  Default: true
  Description: Allows players to use /mine command

mineworlds.vip
  Default: op
  Description: VIP features
    - Infinite mining time
    - Reduced cooldowns (5 minutes instead of 25 for nether)
    - World revisit capability
    - Up to 5 world history slots

mineworlds.admin
  Default: op
  Description: Administrator access to all features

mineworlds.history
  Default: true
  Description: View mining world history

mineworlds.history.revisit
  Default: op
  Description: Click worlds in history GUI to revisit
  Note: Requires mineworlds.vip permission

mineworlds.cooldown.bypass
  Default: op
  Description: Bypass all cooldown restrictions

mineworlds.reload
  Default: op
  Description: Reload plugin configuration
  Command: /mineworlds reload
 


2. Configuration Guide

Basic Settings

Code (Text):

# Language selection
language: "en_US"
# Options: en_US, pt_BR, es_ES, it_IT, ru_RU, zh_CN

# Debug mode - detailed console logging
debug: false
 


3. World Settings

World Size & Dimensions

Code (Text):

world:
  # World size in blocks (radius from center)
  # Default: 25 (creates a 50x50 area)
  size: 25

  # World height limits (1.17+ extended height)
  min-height: -64
  max-height: 320

  # Display name for tablist and plugins
  display-name: "Miner"
 
World Border

Code (Text):

border:
  enabled: true
  damage: 0.2              # Damage per second outside border
  warning-distance: 5       # Warning distance before border

  effects:
    particles: true         # Show particles at border
    particle-type: "CRIT"   # Particle type
    sound: false            # Play sound at border
    sound-type: "BLOCK_NOTE_BLOCK_BASS"

pushback:
  enabled: true
  force: 1.5               # Knockback strength

  particles:
    enabled: true
    type: "SMOKE_LARGE"
    amount: 20

  sound:
    enabled: true
    type: "ENTITY_VILLAGER_NO"
    volume: 1.0
    pitch: 1.0

# Warning cooldown (seconds) - prevents chat spam
warning-cooldown: 300
 
Biome Settings

Code (Text):

biomes:
  random: true             # Random biome selection

  # Blacklisted biomes (never spawn here)
  blacklist:
    - "OCEAN"
    - "DEEP_OCEAN"
    - "WARM_OCEAN"
    - "LUKEWARM_OCEAN"
    - "COLD_OCEAN"
    - "FROZEN_OCEAN"
    - "RIVER"
    - "FROZEN_RIVER"
    - "MUSHROOM_FIELDS"

  default: "PLAINS"        # Used if random is false
 
Spawn Safety

Code (Text):

spawn:
  max-attempts: 50         # Max attempts to find safe spawn
  avoid-liquids: true      # Avoid spawning near water/lava
  liquid-distance: 5       # Minimum distance from liquids
 
Tree Generation

Code (Text):

trees:
  enabled: true
  trees-per-chunk: 4       # 0-10 trees per chunk
  spawn-chance: 0.7        # 0.0-1.0 (70% chance)
  min-height: 8
  max-height: 15

  # Tree types distribution:
  # Oak: 40%, Spruce: 30%, Birch: 20%, Dark Oak: 10%
 


4. Time & Cooldown System

Time Limits

Code (Text):

time:
  default-limit: 900       # 15 minutes in seconds
  enabled: true

  # Action bar update rate (20 ticks = 1 second)
  actionbar-update-interval: 20

  # Warning times in seconds
  warnings:
    - 300    # 5 minutes remaining
    - 60     # 1 minute remaining
    - 30     # 30 seconds remaining
    - 10     # 10 seconds remaining
 
Overworld Cooldown

Code (Text):

cooldown:
  overworld:
    time: 300              # 5 minutes cooldown
    show-actionbar: true
   
    sound:
      enabled: true
      type: "ENTITY_VILLAGER_NO"
      volume: 1.0
      pitch: 1.0
 
Nether Cooldown

Code (Text):

nether:
  enabled: true
  time-limit: 900          # 15 minutes

  cooldown:
    normal: 1500           # 25 minutes for normal players
    vip: 300               # 5 minutes for VIP players
    show-actionbar: true
   
    sound:
      enabled: true
      type: "ENTITY_VILLAGER_NO"
      volume: 1.0
      pitch: 1.0
 


5. Return World Configuration

NEW in Version 1.0.1

Configure which world players return to when leaving mining worlds. Perfect for servers with lobby systems, spawn worlds, or hub areas.

Configuration

Code (Text):

teleport:
  # Set the world where players return when leaving mining worlds
  # Default: "world" (main overworld)
  # You can use any world name from your server
  return-world: "world"

  # Examples of common configurations:
  # return-world: "lobby"     # Return to lobby world
  # return-world: "spawn"     # Return to spawn world
  # return-world: "hub"       # Return to hub world
  # return-world: "survival"  # Return to survival world
 
How It Works

The return world is used when players leave mining worlds through:
  • /leavemine command
  • Player death in mining world
  • Time expiration (when time limit runs out)
  • Player quit/disconnect

Automatic Fallback

If the configured world doesn't exist:
  • Plugin automatically uses the default world (first world loaded)
  • A warning is logged in the console
  • Players are still teleported safely
  • No errors or crashes occur

Use Cases

Lobby Server:
Code (Text):

return-world: "lobby"
 
Hub Network:
Code (Text):

return-world: "hub"
 
Spawn Protection:
Code (Text):

return-world: "spawn"
 
Multiple Survival Worlds:
Code (Text):

return-world: "survival_main"
 
6. Special Ores Configuration

Ore Settings

Code (Text):

special-ores:
  enabled: true

  ores:
    diamond_block:
      chance: 0.005        # 0.5% spawn rate
      min-height: -64
      max-height: 16
      effects:
        particle: "FIREWORK"
        sound: "ENTITY_PLAYER_LEVELUP"
        volume: 1.0
        pitch: 1.5
   
    netherite_block:
      chance: 0.003        # 0.3% spawn rate (legendary)
      min-height: -64
      max-height: 0
      effects:
        particle: "SOUL_FIRE_FLAME"
        sound: "BLOCK_ANVIL_LAND"
        volume: 0.8
        pitch: 2.0
   
    emerald_block:
      chance: 0.004        # 0.4% spawn rate
      min-height: -32
      max-height: 32
      effects:
        particle: "VILLAGER_HAPPY"
        sound: "ENTITY_EXPERIENCE_ORB_PICKUP"
        volume: 1.0
        pitch: 2.0
   
    gold_block:
      chance: 0.008        # 0.8% spawn rate
      min-height: -64
      max-height: 32
      effects:
        particle: "CRIT_MAGIC"
        sound: "ENTITY_EXPERIENCE_ORB_PICKUP"
        volume: 0.7
        pitch: 1.2
   
    iron_block:
      chance: 0.010        # 1.0% spawn rate
      min-height: -64
      max-height: 72
      effects:
        particle: "CRIT"
        sound: "BLOCK_ANVIL_USE"
        volume: 0.5
        pitch: 1.0
 
Rarity Breakdown
  • Netherite Block: 0.3% - Legendary (1 in 333 blocks)
  • Emerald Block: 0.4% - Special (1 in 250 blocks)
  • Diamond Block: 0.5% - Rare (1 in 200 blocks)
  • Gold Block: 0.8% - Uncommon (1 in 125 blocks)
  • Iron Block: 1.0% - Common (1 in 100 blocks)



7. VIP Features

History & Revisit

Code (Text):

history:
  enabled: true
  max-entries: 50          # Max history entries per player
  retention-hours: 12      # How long to keep history

  vip-revisit:
    enabled: true
    max-worlds: 5          # Number of worlds VIP can revisit
    time-window: 6         # Revisit window in hours
 
VIP Benefits
  • Infinite mining time (no 15-minute limit)
  • Reduced nether cooldown (5 minutes vs 25 minutes)
  • World revisit capability
  • Mining history tracking (up to 5 worlds)
  • Special action bar display showing infinite time

Setting Up VIP
  1. Grant permission: mineworlds.vip
  2. Grant permission: mineworlds.history.revisit
  3. Configure VIP cooldown in config (default: 300 seconds)
  4. Adjust max-worlds and time-window as desired



8. Multi-Language Setup

Available Languages
  • en_US - English (United States)
  • pt_BR - Portuguese (Brazil)
  • es_ES - Spanish (Spain)
  • it_IT - Italian (Italy)
  • ru_RU - Russian (Russia)
  • zh_CN - Chinese Simplified (China)

Changing Language

Code (Text):

# In config.yml
language: "pt_BR"    # Change to your preferred language
 
Then reload: /mineworlds reload

Creating Custom Translations

  1. Navigate to plugins/MineWorlds/languages/
  2. Copy en_US.yml to your_LANG.yml
  3. Translate all message values (keep keys unchanged)
  4. Update config.yml language setting
  5. Reload plugin



9. Troubleshooting

Common Issues

Q: Players can't use /mine command
A: Check permission mineworlds.use is granted

Q: World doesn't delete after player quits
A: Enable debug mode in config, reproduce issue, check console logs

Q: Special ores not spawning
A: Verify special-ores.enabled: true in config
Check spawn rates aren't too low
Ensure mining at correct Y levels

Q: Time limit not working for VIPs
A: VIPs have infinite time by design
Check mineworlds.vip permission

Q: Cooldown showing wrong time
A: Check cooldown settings in config
VIPs use different cooldown (5min vs 25min for nether)
Verify mineworlds.cooldown.bypass not granted

Q: Commands blocked in mining world
A: Check restrictions.blocked-commands section
/home commands are allowed by default
/sethome is blocked to prevent exploits

Q: Nether mining not available
A: Verify nether.enabled: true in config
Check server version supports nether generation (1.17+)

Q: Players not returning to correct world
A: Check teleport.return-world in config
Verify the world name is spelled correctly
Ensure the world is loaded on server start
Check console for "Return world not found" warnings

Q: Console shows "Return world 'xyz' not found"
A: The configured world doesn't exist on your server
Update teleport.return-world with a valid world name
Plugin will use default world automatically (safe fallback)

Performance Optimization

Code (Text):

performance:
  async-generation: true       # Keep enabled for best performance
  auto-save-interval: 6000     # 5 minutes, -1 to disable
  cleanup-delay: 10            # Seconds before cleaning empty worlds
 
Tips:
  • Keep async-generation enabled
  • Reduce world.size for lower memory usage
  • Decrease trees-per-chunk if lag occurs
  • Increase cleanup-delay if worlds delete too fast

Debug Mode

Enable detailed logging:
Code (Text):

debug: true
 
Debug logs will show:
  • World creation process
  • Player teleportation events
  • World deletion tracking
  • Timer management
  • Cooldown calculations



10. Restrictions

Command Restrictions

Code (Text):

restrictions:
  # Block golden shovel (GriefPrevention claims)
  block-golden-shovel: true

  # Block Essentials /sethome in mining worlds
  block-essentials-home: true

  # Blocked commands list
  blocked-commands:
    - "sethome"    # Prevent home setting exploits
    - "tpa"        # Prevent teleport exploits
    - "tpahere"    # Prevent teleport exploits

  # Note: /home and /homes are ALLOWED by default
 
Portal Blocking
  • Nether portals cannot be created in mining worlds
  • Portal teleportation is disabled
  • Prevents players from escaping world borders

Combat Protection

Code (Text):

teleport:
  pvp-protection:
    enabled: true
    duration: 10           # Seconds after combat before teleport allowed
 
11. Teleport Settings

Teleport Effects

Code (Text):

teleport:
  # Return world configuration (NEW in 1.0.1)
  return-world: "world"    # World to return to when leaving

  # Freeze player during teleport
  freeze:
    enabled: true
    duration: 3            # Seconds
    level: 10              # Slowness level

  # Particles during teleport
  particles:
    enabled: true
    type: "PORTAL"
    amount: 50

  # Sound during teleport
  sound:
    enabled: true
    type: "ENTITY_ENDERMAN_TELEPORT"
    volume: 1.0
    pitch: 1.0

  # Invincibility after teleport
  invincibility-duration: 5    # Seconds
 


Need more help? Check the discussion thread or report issues!

MineWorlds Documentation - Version 1.0.1
Last Updated: November 2025​
View on SpigotMC
Resource Information
Author:
----------
Total Downloads: 37
First Release: Nov 7, 2025
Last Update: Nov 7, 2025
Category: ---------------
All-Time Rating:
1 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings