Introduction

UltimateWorldVoidGenerator is a powerful Minecraft plugin designed to facilitate the creation and management of void worlds—worlds that are completely empty except for a single bedrock block at the spawn point. These worlds are ideal for custom maps, skyblock challenges, or any scenario where you need a blank slate. The plugin also provides robust tools to control player interactions, mob spawning, and environmental effects, ensuring that your void worlds remain precisely as you intend them.

Installation

Requirements

Before installing UltimateWorldVoidGenerator, ensure that your server meets the following requirements:

• Minecraft Server: Spigot or PaperMC server running Minecraft version 1.13 through 1.20.
• Java: Java 8 or later is required to run the server.
• Permissions Plugin: A plugin such as LuckPerms, PermissionsEx, or GroupManager to manage player permissions.

Download and Installation

1. Download the Plugin:

   • Visit the SpigotMC or GitHub Releases page to download the latest .jar file of UltimateWorldVoidGenerator.

2. Install the Plugin:

   • Copy the downloaded .jar file into the plugins directory of your Minecraft server.

3. Restart Your Server:

   • Restart your server to load the plugin. The plugin will generate necessary configuration files in the plugins/UltimateWorldVoidGenerator directory.

Initial Setup

Once the plugin is installed, it will automatically generate the following files:

• config.yml: Contains the main configuration for worlds and regions.
• data.yml: Stores information about created void worlds.
• messages.yml: Allows customization of all plugin messages.

Review these files to ensure the settings align with your server's needs.

Getting Started

Creating a Void World

Creating a void world is straightforward and can be done with a single command:

/uwv create <worldName>

worlds:
  SkyblockWorld:
    RegionControl:
      regions:
        SpawnArea:
          BlockBreak: false
          BlockPlace: false
          MobSpawning: true
          BannedMobs:
            - CREEPER
            - SPIDER
          ExplosionControl: false

This allows you to create safe zones or challenging areas with different mob spawning rules.

Explosion Control

Prevent or allow explosions globally or within specific regions to protect your builds or create dangerous zones:

• Global Explosion Control:

  ExplosionControl: true
  

• Region-Specific Explosion Control:
  

  RegionControl:
    regions:
      <regionName>:
        ExplosionControl: true
  

  Custom Region Permissions

  You can also create custom permissions for each region, granting or restricting specific actions to players:

  • Permissions Configuration:
    

    RegionControl:
      regions:
        <regionName>:
          Permissions:
            BlockBreak: true
            BlockPlace: true
            MobSpawning: true
            ExplosionControl: false
    

    
    These permissions give you granular control over what players can do in different parts of the void world.
    
    

    Commands and Permissions

    Detailed Command List

    Here’s a comprehensive list of commands provided by the plugin, along with their descriptions and usage:

    /uwv create <world>	Creates a new void world	/uwv create SkyblockWorld
    /uwv tp <world>	Teleports you to the specified void world	/uwv tp SkyblockWorld
    /uwv setspawn	Sets the spawn point in the current world	/uwv setspawn
    /uwv delete <world>	Deletes the specified void world	/uwv delete SkyblockWorld
    /uwv list	Lists all void worlds	/uwv list
    /uwv reload	Reloads the plugin configuration	/uwv reload
    /uwv region create <region>	Creates a new region in the world	/uwv region create SpawnArea
    /uwv region setpos1	Sets the first position for the region	/uwv region setpos1
    /uwv region setpos2	Sets the second position for the region	/uwv region setpos2
    /uwv region save <region>	Saves the region with defined flags	/uwv region save SpawnArea

    Permissions Overview

    Permissions allow you to control which players can execute specific commands or actions within the plugin. Below is a detailed list of permissions and their corresponding commands:

    ultimateworldvoidgenerator.create	/uwv create <world>	Allows the player to create new void worlds.
    ultimateworldvoidgenerator.tp	/uwv tp <world>	Allows the player to teleport to void worlds.
    ultimateworldvoidgenerator.setspawn	/uwv setspawn	Allows the player to set the spawn point.
    ultimateworldvoidgenerator.delete	/uwv delete <world>	Allows the player to delete void worlds.
    ultimateworldvoidgenerator.list	/uwv list	Allows the player to list all void worlds.
    ultimateworldvoidgenerator.reload	/uwv reload	Allows the player to reload plugin configuration.
    ultimateworldvoidgenerator.region.create	/uwv region create <region>	Allows the player to create regions.
    ultimateworldvoidgenerator.region.manage	/uwv region setpos1, /uwv region setpos2	Allows the player to define region boundaries.
    ultimateworldvoidgenerator.region.save	/uwv region save <region>	Allows the player to save region configurations.

    ---

    Configuration Files

    The plugin uses several configuration files to store settings and world data. Here’s a breakdown of each:

    config.yml

    The config.yml file is the primary configuration file where you can set global and per-world settings. Here’s a sample structure:

    worlds:
      <world_name>:
        Configuration: "custom"   # Use 'default' or 'custom'
        MobControl:
          MobSpawning: true       # Allow mobs to spawn
          BannedMobs:             # List of mobs that are banned from spawning in this world
            - ZOMBIE
            - SKELETON
        BuildControl:
          BlockBreak: true        # Allow or prevent block breaking
          BlockPlace: true        # Allow or prevent block placing
        ExplosionControl: true     # Allow or prevent explosions
        RegionControl:
          regions:
            <region_name>:
              BlockBreak: true    # Allow or prevent block breaking in this region
              BlockPlace: true    # Allow or prevent block placing in this region
              MobSpawning: true   # Allow or prevent mob spawning in this region
              BannedMobs:
                - CREEPER
                - SPIDER
              ExplosionControl: true  # Allow or prevent explosions in this region
    

    data.yml

    The data.yml file stores persistent data about the void worlds created by the plugin. This includes:

    • World Data: The names and configurations of all void worlds.
    • Region Data: Information about regions within each world.
      

      worlds:
        SkyblockWorld:
          created: true
          regions:
            SpawnArea:
              BlockBreak: false
              BlockPlace: false
      

      
      
      

      messages.yml

      The messages.yml file allows you to customize all in-game messages. These messages can include placeholders for dynamic content and can be styled using Minecraft’s color codes.
      
      

      create_world_success: "&aWorld {world} created successfully!"
      tp_world_success: "&aTeleported to {world}!"
      delete_world_success: "&aWorld {world} deleted successfully!"
      no_permission: "&cYou do not have permission to execute this command."
      usage_command: "&eUsage: /uwv <create|tp|delete|list|setspawn|reload>"