Boost_Areas.json - Unariginal/MoreSparkles GitHub Wiki

Boost_Areas.json

Defines boost areas: regions of a world where every player inside gets a boost. Located at config/MoreSparkles/boost_areas.json.

Warning

1.3.0 breaking changes in this file: every area now needs a boost_type and a display_name. Areas from older versions were always Shiny areas, so add "boost_type": "shiny" to keep them working the same way.

📄 Full default file 
{
  "cuboid_example": {
    "type": "cuboid",
    "display_name": "Cubical Shinies",
    "multiplier": 2.0,
    "boost_type": "shiny",
    "shape": {
      "world": "minecraft:overworld",
      "x_min": -200.0,
      "x_max": -100.0,
      "y_min": -64.0,
      "y_max": -50.0,
      "z_min": 235.0,
      "z_max": 335.0
    },
    "particles": {
      "enabled": true,
      "identifier": "minecraft:end_rod",
      "speed": 0.0,
      "count": 2
    }
  },
  "cylinder_example": {
    "type": "cylinder",
    "display_name": "Cylindrical Shinies",
    "multiplier": 2.0,
    "boost_type": "shiny",
    "shape": {
      "world": "minecraft:overworld",
      "center_x": 0,
      "center_z": 0,
      "radius": 10,
      "y_min": -64,
      "y_max": -50
    },
    "particles": {
      "enabled": true,
      "identifier": "minecraft:end_rod",
      "speed": 0.0,
      "count": 2
    }
  }
}

Caution

The default file ships with two working example areas: 2x Shiny areas deep underground in the Overworld, one of them under 0, 0. Remove or edit them before using the mod on a live server.

Top Level

Field Type Description
<area_id> object A single boost area, keyed by its own unique ID. The ID is used by /sparkles area info <id>. Contains the fields below.

Area Fields

Field Type Description
type string The area's shape: cuboid or cylinder.
display_name string The name shown by %boost_area_name%.
boost_type string Which boost type this area gives. Case-insensitive.
multiplier number The area's multiplier. Stacks with other boosts. See How-It-Works.
shape object Where the area is. The fields depend on type. See below.
particles object Particles that show the area's boundaries. See Particles.

An area gives one boost type. To boost several types in the same place, add one area per type with the same shape.

Cuboid Shape — shape for "type": "cuboid"

A box between two corners.

Field Type Description
world string The world ID, e.g. minecraft:overworld, minecraft:the_nether, minecraft:the_end.
x_min / x_max number The area's X range.
y_min / y_max number The area's Y range.
z_min / z_max number The area's Z range.

Each _min value must be lower than its _max value, or nobody will ever be inside the area.

Cylinder Shape — shape for "type": "cylinder"

A circle with a height range.

Field Type Description
world string The world ID, e.g. minecraft:overworld.
center_x / center_z number The center of the circle.
radius number The circle's radius in blocks.
y_min / y_max number The area's Y range.

Note

If world doesn't match a loaded world, the area uses the Overworld instead.

Particles — particles

Spawns random particles throughout the area every 2 to 5 seconds, so players can see where it is.

Field Type Description
enabled boolean Toggle the particles.
identifier string The particle ID, e.g. minecraft:end_rod, minecraft:happy_villager, minecraft:glow. Only simple particles work: particles that need extra settings, like minecraft:dust, are skipped. See the list of particles on the Minecraft Wiki.
speed number How fast the particles move. 0 keeps them still.
count integer Particles per spawn point.

Larger areas get more spawn points.

Examples

A 3x Hidden Ability area around a safari zone:

{
  "safari_zone": {
    "type": "cuboid",
    "display_name": "Safari Zone",
    "boost_type": "hidden_ability",
    "multiplier": 3.0,
    "shape": {
      "world": "minecraft:overworld",
      "x_min": 500.0,
      "x_max": 700.0,
      "y_min": 50.0,
      "y_max": 150.0,
      "z_min": -200.0,
      "z_max": 0.0
    },
    "particles": {
      "enabled": false,
      "identifier": "minecraft:end_rod",
      "speed": 0.0,
      "count": 2
    }
  }
}

A 2x Experience area around a training arena:

{
  "training_arena": {
    "type": "cylinder",
    "display_name": "Training Arena",
    "boost_type": "experience",
    "multiplier": 2.0,
    "shape": {
      "world": "minecraft:overworld",
      "center_x": 100,
      "center_z": 100,
      "radius": 30,
      "y_min": 60,
      "y_max": 90
    },
    "particles": {
      "enabled": true,
      "identifier": "minecraft:happy_villager",
      "speed": 0.0,
      "count": 1
    }
  }
}

Tip

Stand inside an area and run /sparkles area info to check that it's set up correctly. Changes to this file apply with /sparkles reload.

See Also

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