Skip to content
Adam Matthiesen's MC Development
These docs are a work in progress and may be incomplete or contain inaccuracies. (Or be for a newer unreleased version of the mod)

Falling Star Rewards Configuration

The following configuration options are available in the Falling Star Rewards mod. These options can be set in the mod’s configuration file, which can be found in the server’s config directory after installing the mod.

Config files

Section titled “Config files”

Main Config options

Section titled “Main Config options”

These options control the core behavior of the mod, including how falling star events are scheduled, activated, and how the falling stars behave in the world.

  • enabled: master switch.
  • enablePresetGeneration: whether to generate example preset files on first run. This is intended to help server owners get started with customizing the mod, but can be turned off if not needed. The generated presets are just examples and are not used by default, so they can be safely deleted or modified without affecting the mod’s functionality.
  • claim
    • lifeTicks: despawn timer for spawned stars.
    • pickupDelayTicks: delay before pickup is allowed.
    • maxActiveDrops: hard cap for concurrently tracked star drops.
  • scheduler
    • baseIntervalTicks: base delay between cycles.
    • intervalJitterTicks: random extra delay (0..jitter).
    • maxStarsPerCycle: cap events started in one cycle.

Example config file

Section titled “Example config file”
<game_directory>/config/falling_star_rewards/config.json
{
  "enabled": true,
  "enablePresetGeneration": true,
  "claim": {
    "lifeTicks": 900,
    "pickupDelayTicks": 10,
    "maxActiveDrops": 64
  },
  "scheduler": {
    "baseIntervalTicks": 2400,
    "intervalJitterTicks": 600,
    "maxStarsPerCycle": 1
  }
}

Announcements Config options

Section titled “Announcements Config options”

These options control the in-game announcements related to falling star events, such as whether to show a message when a star spawns, and who can see the message.

  • enabled: show spawn message.
  • scope: nearby | global.
  • useActionBar: show spawn message in action bar instead of chat.
  • spawnMessage: chat message on spawn.

Example config file

Section titled “Example config file”
<game_directory>/config/falling_star_rewards/announcements.json
{
  "enabled": true,
  "scope": "nearby",
  "useActionBar": false,
  "spawnMessage": "A falling star has appeared nearby!"
}

Permissions Config options

Section titled “Permissions Config options”

These options control the permissions required to use the mod’s commands and features.

  • command: permission levels for commands. The root command node sets the default permission level for all commands, which can be overridden by specifying a different level for individual subcommands. Permission levels are defined as integers, where higher values indicate higher required permissions (e.g., 0 for all players, 2 for trusted players, 4 for server operators). The specific permission nodes are structured as follows:
    • root: default permission level for all commands.
    • fallingstar: permission levels for the main fallingstar command and its subcommands.
      • help: permission level for the help subcommand.
      • reload: permission level for the reload subcommand.
      • cleanup: permission level for the cleanup subcommand.
      • status: permission level for the status subcommand.
      • force: permission level for the force subcommand.
      • confirm-delete: permission level for the confirm-delete subcommand, which is used to confirm the deletion of tracked drops when using the cleanup command.
      • preset: permission levels for the preset subcommands, which are used to manage event presets.
        • enable: permission level for the preset enable subcommand, which is used to enable specific event presets.
        • disable: permission level for the preset disable subcommand, which is used to disable specific event presets.
        • list: permission level for the preset list subcommand, which is used to list all available event presets and their statuses.
        • create: permission level for the preset create subcommand, which is used to create new event presets.
        • delete: permission level for the preset delete subcommand, which is used to delete existing event presets.
        • info: permission level for the preset info subcommand, which is used to display detailed information about specific event presets.
        • set: permission level for the preset set subcommand, which is used to modify the parameters of existing event presets.
        • add: permission level for the preset add subcommand, which is used to add rewards or visuals presets to event presets.
        • remove: permission level for the preset remove subcommand, which is used to remove rewards or visuals presets from event presets.

Example config file

Section titled “Example config file”
<game_directory>/config/falling_star_rewards/permissions.json
{
  "command": {
    "root": 4,
    "fallingstar": {
      "help": 4,
      "reload": 4,
      "cleanup": 4,
      "status": 4,
      "force": 4,
      "confirm-delete": 4,
      "preset": {
        "enable": 4,
        "disable": 4,
        "list": 4,
        "create": 4,
        "delete": 4,
        "info": 4,
        "set": 4,
        "add": 4,
        "remove": 4
      }
    }
  }
}

Events Presets

Section titled “Events Presets”

Events presets are JSON files that define the conditions and parameters for falling star events. These presets can be used to create different types of events with varying difficulty, rewards, and visuals. Server owners can create their own presets by following the structure of the example preset files generated by the mod.

  • enabled: whether this event can be selected for spawning. This allows server owners to have a library of presets and easily enable or disable them without deleting the files.
  • rewardsPresetId: the ID of the rewards preset to use for this event.
  • visualsPresetId: the ID of the visuals preset to use for this event.
  • activation: conditions for activating the event.
    • requireNight: whether it must be night to activate.
    • requireSurfaceAccess: whether the spawn location must have access to the sky.
    • weatherMode: any | clear | storm - whether to activate in any weather, only clear weather, or only during storms.
  • spawn: parameters for spawning the falling star.
    • targetScope: per_player | global - whether to spawn stars targeting each player individually, or just spawn a single star globally.
    • minRadius: minimum spawn radius from the target player (or players, if targetScope is per_player).
    • maxRadius: maximum spawn radius from the target player (or players, if targetScope is per_player).
    • maxLocationAttempts: maximum number of attempts to find a valid spawn location.
    • allowWaterSpawns: whether stars can spawn in water.
<game_directory>/config/falling_star_rewards/events/<event_id>.json
{
  "enabled": true,
  "rewardsPresetId": "base",
  "visualsPresetId": "base",
  "activation": {
    "requireNight": true,
    "requireSurfaceAccess": true,
    "weatherMode": "any"
  },
  "spawn": {
    "targetScope": "per_player",
    "minRadius": 16,
    "maxRadius": 48,
    "maxLocationAttempts": 12,
    "allowWaterSpawns": false
  }
}

Rewards Presets

Section titled “Rewards Presets”

Rewards presets are JSON files that define the rewards that can be dropped by falling stars during events. These presets allow server owners to customize the loot that players can receive from falling star events, and can include a variety of items with different rarities and drop chances. Server owners can create their own rewards presets by following the structure of the example preset files generated by the mod.

  • entries: a list of possible rewards that can be dropped by the falling star. Each entry includes:
    • id: the item ID of the reward (e.g., minecraft:diamond).
    • weight: the relative chance of this reward being selected compared to other entries in the same preset. Higher weight means higher chance.
    • minCount: the minimum quantity of the item that can be dropped when this reward is selected.
    • maxCount: the maximum quantity of the item that can be dropped when this reward is selected.
    • customModelData: (optional) the custom model data value (integer) to apply to the item, if applicable.
    • customData: (optional) a String containing custom JSON data to apply to the item, which can be used for mod-specific features or integrations with other mods that read custom data from items.
<game_directory>/config/falling_star_rewards/rewards/<rewards_id>.json
{
  "entries": [
    {
      "id": "minecraft:amethyst_shard",
      "weight": 20,
      "minCount": 1,
      "maxCount": 3
    },
    {
      "id": "minecraft:glowstone_dust",
      "weight": 12,
      "minCount": 2,
      "maxCount": 5
    },
    {
      "id": "minecraft:nether_star",
      "weight": 1,
      "minCount": 1,
      "maxCount": 1
    }
  ]
}

Visuals Presets

Section titled “Visuals Presets”

Visuals presets are JSON files that define the visual and audio effects associated with falling star events. These presets allow server owners to customize the appearance and sounds of falling stars, making each event more unique and immersive. Server owners can create their own visuals presets by following the structure of the example preset files generated by the mod.

  • enabled: toggles falling-star particle trail above active drops.
  • particlePreset: end_rod | ash | glow | firework.
  • fallDistance: vertical distance above drop where the trail starts.
  • emissionIntervalTicks: particle emission cadence.
  • particlesPerEmission: how many particles to emit each time.
  • impact: parameters for the impact effects when the star lands.
    • burstEnabled: whether to spawn a burst of particles on impact.
    • particlePreset: end_rod | ash | glow | firework - the type of particles to use for the impact burst.
    • particleCount: how many particles to emit in the impact burst.
    • spread: how far from the impact center to randomly spawn particles (in blocks).
    • soundEnabled: whether to play a sound on impact.
    • soundId: the ID of the sound to play on impact (e.g., minecraft:entity.firework_rocket.twinkle).
    • soundVolume: the volume at which to play the impact sound.
    • soundPitchMin: the minimum pitch for the impact sound (the actual pitch will be a random value between soundPitchMin and soundPitchMax).
    • soundPitchMax: the maximum pitch for the impact sound.
  • travelSound: parameters for the sound played while the star is falling.
    • enabled: whether to play a sound while the star is falling.
    • id: the ID of the sound to play while the star is falling (e.g., minecraft:entity.phantom.flap).
    • volume: the volume at which to play the travel sound.
    • pitchMin: the minimum pitch for the travel sound (the actual pitch will be a random value between pitchMin and pitchMax).
    • pitchMax: the maximum pitch for the travel sound.
    • intervalTicks: the interval in ticks between each travel sound emission.
<game_directory>/config/falling_star_rewards/visuals/<visuals_id>.json
{
  "enabled": true,
  "particlePreset": "end_rod",
  "fallDistance": 10,
  "emissionIntervalTicks": 3,
  "particlesPerEmission": 2,
  "impact": {
    "burstEnabled": true,
    "particlePreset": "firework",
    "particleCount": 14,
    "spread": 0.4,
    "soundEnabled": true,
    "soundId": "minecraft:entity.firework_rocket.twinkle",
    "soundVolume": 0.8,
    "soundPitchMin": 0.9,
    "soundPitchMax": 1.2
  },
  "travelSound": {
    "enabled": true,
    "id": "minecraft:entity.phantom.flap",
    "volume": 0.12,
    "pitchMin": 1.3,
    "pitchMax": 1.7,
    "intervalTicks": 12
  }
}