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

• Server Config: <game_directory>/config/falling_star_rewards/server.toml
• Permissions Config: <game_directory>/config/falling_star_rewards/permissions.toml
• Scheduling Presets: <game_directory>/config/falling_star_rewards/schedules.toml
• Events Presets: <game_directory>/config/falling_star_rewards/events.toml
• Rewards Presets: <game_directory>/config/falling_star_rewards/rewards.toml
• Visuals Presets: <game_directory>/config/falling_star_rewards/visuals.toml

Server Config options

<game_directory>/config/falling_star_rewards/server.toml

#General configuration settings
[general]
  enabled = true
  enabledSchedules = ["base"]

  #Claim configuration settings
  [general.claim]
    lifeTicks = 900
    pickupDelayTicks = 10
    maxActiveDrops = 64

General Configuration

enabled

Enable or disable the Falling Star Rewards mod.

• Type: Boolean
• Default: true

enabledSchedules

A list of enabled scheduling presets for the Falling Star Rewards mod. Each entry in the list corresponds to a scheduling preset file located in the scheduling directory.

• Type: List of Strings
• Default: ["base"]

Claim Configuration

Claim configuration settings control the behavior of item claims dropped by falling stars.

lifeTicks

The lifespan of a claim in ticks (20 ticks = 1 second). After this time, the claim will despawn if not picked up.

• Type: Integer
• Default: 900
• Range: > 1

pickupDelayTicks

The delay before a claim can be picked up in ticks (20 ticks = 1 second). This prevents immediate pickup of the claim after it is dropped.

• Type: Integer
• Default: 10
• Range: > 0

maxActiveDrops

The maximum number of active drops allowed at once. If the number of active drops exceeds this limit, new drops will not be spawned until the number of active drops decreases.

• Type: Integer
• Default: 64
• Range: > 1

Permissions Config options

<game_directory>/config/falling_star_rewards/permissions.toml

#Permission Configuration
[permissions]

  #Command Permissions
  [permissions.command]
    fallingstar = "ALL_COMMANDS"
    fallingstar_help = "ALL_COMMANDS"
    fallingstar_reload = "ALL_COMMANDS"
    fallingstar_cleanup = "ALL_COMMANDS"
    fallingstar_status = "ALL_COMMANDS"
    fallingstar_force = "ALL_COMMANDS"
    fallingstar_confirm_delete = "ALL_COMMANDS"

    #Preset Command Permissions
    [permissions.command.preset]
      fallingstar_preset_enable = "ALL_COMMANDS"
      fallingstar_preset_disable = "ALL_COMMANDS"
      fallingstar_preset_list = "ALL_COMMANDS"
      fallingstar_preset_create = "ALL_COMMANDS"
      fallingstar_preset_delete = "ALL_COMMANDS"
      fallingstar_preset_info = "ALL_COMMANDS"
      fallingstar_preset_set = "ALL_COMMANDS"
      fallingstar_preset_add = "ALL_COMMANDS"
      fallingstar_preset_remove = "ALL_COMMANDS"

Command Permissions Configuration

Allowed Values:

• NONE - No permission required.
• SPAWN_PROTECTION_BYPASS - Permission level required to bypass spawn protection
• CHEAT_COMMANDS_AND_COMMAND_BLOCKS - Permission level required to use cheat commands and command blocks.
• MULTIPLAYER_MANAGEMENT - Permission level required to manage multiplayer settings
• ALL_COMMANDS - Permission level required to use all commands.

fallingstar

The permission level required to use the /fallingstar command.

• Default: ALL_COMMANDS

fallingstar_help

The permission level required to use the /fallingstar help command.

• Default: ALL_COMMANDS

fallingstar_reload

The permission level required to use the /fallingstar reload command.

• Default: ALL_COMMANDS

fallingstar_cleanup

The permission level required to use the /fallingstar cleanup command.

• Default: ALL_COMMANDS

fallingstar_status

The permission level required to use the /fallingstar status command.

• Default: ALL_COMMANDS

fallingstar_force

The permission level required to use the /fallingstar force command.

• Default: ALL_COMMANDS

fallingstar_confirm_delete

The permission level required to use the /fallingstar confirm_delete command.

• Default: ALL_COMMANDS

Preset Command Permissions Configuration

Contains the permission levels required to use the preset-related commands under the /fallingstar preset command.

fallingstar_preset_enable

The permission level required to use the /fallingstar preset enable command.

• Default: ALL_COMMANDS

fallingstar_preset_disable

The permission level required to use the /fallingstar preset disable command.

• Default: ALL_COMMANDS

fallingstar_preset_list

The permission level required to use the /fallingstar preset list command.

• Default: ALL_COMMANDS

fallingstar_preset_create

The permission level required to use the /fallingstar preset create command.

• Default: ALL_COMMANDS

fallingstar_preset_delete

The permission level required to use the /fallingstar preset delete command.

• Default: ALL_COMMANDS

fallingstar_preset_info

The permission level required to use the /fallingstar preset info command.

• Default: ALL_COMMANDS

fallingstar_preset_set

The permission level required to use the /fallingstar preset set command.

• Default: ALL_COMMANDS

fallingstar_preset_add

The permission level required to use the /fallingstar preset add command.

• Default: ALL_COMMANDS

fallingstar_preset_remove

The permission level required to use the /fallingstar preset remove command.

• Default: ALL_COMMANDS

Scheduling Presets

<game_directory>/config/falling_star_rewards/schedules.toml

  #List of schedule presets. Each preset defines the configuration for a specific schedule.
  [[schedules.schedulePresets]]
    baseIntervalTicks = 2400
    intervalJitterTicks = 600
    maxStarsPerCycle = 1
    scheduleId = "base"
    enabled = true
    selectionMode = "RANDOM"

    [schedules.schedulePresets.state]
      rotationCursor = 0

    [schedules.schedulePresets.conditions]
      requireSurfaceAccess = true
      timeMode = "ANY"
      weatherMode = "ANY"
      moonPhases = []

    [[schedules.schedulePresets.eventEntries]]
      eventId = "base"
      weight = 1
      enabled = true

Scheduling Presets Configuration

List of scheduling presets. Each preset defines the configuration for a specific schedule.

baseIntervalTicks

The base interval in ticks (20 ticks = 1 second) between falling star events. This value determines how often falling star events can occur.

• Type: Integer
• Default: 2400

intervalJitterTicks

The amount of random jitter in ticks (20 ticks = 1 second) added to the base interval between falling star events. This value introduces variability in the timing of falling star events.

• Type: Integer
• Default: 600

maxStarsPerCycle

The maximum number of falling stars that can occur in a single cycle. A cycle is defined as the period between the start of one falling star event and the start of the next.

• Type: Integer
• Default: 1

scheduleId

The unique identifier for the scheduling preset. This ID is used to reference the preset in other configuration files.

• Type: String
• Default: "base"

enabled

A boolean value indicating whether the scheduling preset is enabled. If set to false, the preset will not be used in the scheduling of falling star events.

• Type: Boolean
• Default: true

selectionMode

The mode used to select events from the scheduling preset.

• Type: Enum (String)
• Default: "RANDOM"

Possible values are:

• "RANDOM" - Events are selected randomly based on their weights.
• "WEIGHTED" - Events are selected based on their weights, with higher-weighted events being more likely to be selected.
• "ROTATION" - Events are selected in a fixed rotation order.

state

The state of the scheduling preset, which includes the rotation cursor used for selecting events in rotation mode.

rotationCursor

The current position in the rotation order for selecting events. This value is used when the selection mode is set to "ROTATION".

• Type: Integer
• Default: 0

Conditions

The conditions that must be met for the scheduling preset to be active. These conditions include surface access, time mode, weather mode, and moon phases.

requireSurfaceAccess

A boolean value indicating whether surface access is required for the scheduling preset to be active. If set to true, falling star events will only occur if the player has access to the surface.

• Type: Boolean
• Default: true

timeMode

The time mode that determines when falling star events can occur.

• Type: Enum (String)
• Default: "ANY"

Possible values are:

• "ANY" - Events can occur at any time.
• "DAY" - Events can only occur during the day.
• "NIGHT" - Events can only occur during the night.

weatherMode

The weather mode that determines when falling star events can occur.

• Type: Enum (String)
• Default: "ANY"

Possible values are:

• "ANY" - Events can occur in any weather.
• "CLEAR" - Events can only occur during clear weather.
• "RAIN" - Events can only occur during rain.
• "THUNDER" - Events can only occur during thunderstorms.

moonPhases

A list of moon phases during which falling star events can occur. If the list is empty, events can occur during any moon phase.

• Type: List of Strings
• Default: []

Possible values are:

• "full" / "full_moon" / "0"
• "waning_gibbous" / "1"
• "last_quarter" / "last_quarter" / "2"
• "waning_crescent" / "3"
• "new" / "new_moon" / "4"
• "waxing_crescent" / "5"
• "first_quarter" / "6"
• "waxing_gibbous" / "7"

eventEntries

A list of event entries that define the events associated with the scheduling preset. Each entry includes the event ID, weight, and enabled status.

• Type: List of Event Entries

Events Presets

<game_directory>/config/falling_star_rewards/events.toml

  #List of event presets. Each preset defines the configuration for a specific event.
  [[events.eventPresets]]
    eventId = "base"
    visualsPresetId = "base"
    rewardsPresetId = "base"
    enabled = true
    commands = []

    [events.eventPresets.spawn]
      maxRadius = 48
      maxLocationAttempts = 12
      minRadius = 16
      targetScope = "per_player"
      allowWaterSpawns = false

    [events.eventPresets.announcement]
      messages = ["A falling star has appeared nearby!", "A falling star has appeared in the sky!", "A falling star has appeared in the world!"]
      enabled = true
      scope = "nearby"
      useActionBar = false

Events Presets Configuration

An Array of event presets. Each preset defines the configuration for a specific event.

eventId

The unique identifier for the event preset. This ID is used to reference the preset in other configuration files.

• Type: String
• Default: "base"

visualsPresetId

The unique identifier for the visuals preset associated with the event. This ID is used to reference the visuals preset in the event configuration.

• Type: String
• Default: "base"

rewardsPresetId

The unique identifier for the rewards preset associated with the event. This ID is used to reference the rewards preset in the event configuration.

• Type: String
• Default: "base"

enabled

A boolean value indicating whether the event preset is enabled. If set to false, the preset will not be used in the scheduling of falling star events.

• Type: Boolean
• Default: true

commands

A list of commands to be executed when the event occurs. Commands can include placeholders for dynamic values, such as the player’s name or the location of the falling star.

• Type: List of Strings
• Default: []

Available Placeholders:

• %nearbyPlayer% - The name of a nearby player to the falling star event.
• %spawnPos% - The spawn position of the falling star event in the format x,y,z.
• %rewardItem% - The item that was rewarded to the player as a result of the falling star event.

Spawn Configuration

Contains the spawn configuration settings for the event preset, which define how and where falling stars can spawn.

maxRadius

The maximum radius in blocks from the target location within which the falling star can spawn. This value determines how far away from the target location the falling star can appear.

• Type: Integer
• Default: 48

maxLocationAttempts

The maximum number of attempts the mod will make to find a valid spawn location for the falling star. If a valid location is not found within this number of attempts, the event will not occur.

• Type: Integer
• Default: 12

minRadius

The minimum radius in blocks from the target location within which the falling star can spawn. This value determines how close to the target location the falling star can appear.

• Type: Integer
• Default: 16

targetScope

The scope of the target location for the falling star event.

• Type: Enum (String)
• Default: "per_player"

Possible values are:

• "per_player" - The target location is determined individually for each player.
• "global" - The target location is determined globally for all players.

allowWaterSpawns

A boolean value indicating whether falling stars are allowed to spawn in water. If set to false, falling stars will not spawn in water.

• Type: Boolean
• Default: false

Announcement Configuration

Contains the announcement configuration settings for the event preset, which define how and when announcements are made to players about falling star events.

messages

A list of messages to be broadcast to players when the falling star event occurs.

• Type: List of Strings
• Default: ["A falling star has appeared nearby!", "A falling star has appeared in the sky!", "A falling star has appeared in the world!"]

enabled

A boolean value indicating whether announcements are enabled for the event preset. If set to false, no announcements will be made when the event occurs.

• Type: Boolean
• Default: true

scope

The scope of the announcement for the falling star event.

• Type: Enum (String)
• Default: "nearby"

Possible values are:

• "nearby" - Announcements are made to players near the falling star event.
• "global" - Announcements are made to all players on the server.

useActionBar

A boolean value indicating whether announcements should be displayed in the action bar instead of the chat. If set to true, announcements will appear in the action bar.

• Type: Boolean
• Default: false

Rewards Presets

<game_directory>/config/falling_star_rewards/rewards.toml

  #List of reward presets. Each preset defines the configuration for a specific reward.
  [[rewards.rewardPresets]]
    rewardId = "base"
    [[rewards.rewardPresets.entries]]
      itemId = "minecraft:amethyst_shard"
      weight = 20
      minCount = 1
      maxCount = 3
    [[rewards.rewardPresets.entries]]
      itemId = "minecraft:glowstone_dust"
      weight = 12
      minCount = 2
      maxCount = 5
    [[rewards.rewardPresets.entries]]
      itemId = "minecraft:nether_star"
      weight = 1
      minCount = 1
      maxCount = 1

Rewards Presets Configuration

An Array of reward presets. Each preset defines the configuration for a specific reward.

rewardId

The unique identifier for the reward preset. This ID is used to reference the preset in other configuration files.

• Type: String
• Default: "base"

entries

A list of reward entries that define the items and their properties associated with the reward preset. Each entry includes the item ID, weight, minimum count, and maximum count.

itemId

The unique identifier for the item to be rewarded. This ID corresponds to the item’s registry name in Minecraft.

• Type: String
• Default: "minecraft:amethyst_shard"

weight

The weight of the item in the reward preset. Higher weights increase the likelihood of the item being selected as a reward.

• Type: Integer
• Default: 20

minCount

The minimum number of items to be rewarded when the item is selected. This value determines the lower bound of the quantity of the item given to the player.

• Type: Integer
• Default: 1

maxCount

The maximum number of items to be rewarded when the item is selected. This value determines the upper bound of the quantity of the item given to the player.

• Type: Integer
• Default: 3

customModelData

The custom model data value for the item to be rewarded. This value can be used to apply custom textures or models to the item in Minecraft.

• Type: Integer | null
• Default: null

customData

The custom data for the item to be rewarded. This value can be used to apply additional NBT data to the item in Minecraft.

• Type: String | null
• Default: null

Visuals Presets

<game_directory>/config/falling_star_rewards/visuals.toml

  #List of Visuals Presets. Each preset defines the visuals for a falling star event.
  [[visuals.visualsPresets]]
    particlesPerEmission = 2
    fallDistance = 10
    particlePreset = "END_ROD"
    visualsId = "base"
    emissionIntervalTicks = 3
    enabled = true

    [visuals.visualsPresets.travelSound]
      volume = 0.12
      pitchMax = 1.7
      id = "minecraft:entity.phantom.flap"
      intervalTicks = 12
      pitchMin = 1.3
      enabled = true

    [visuals.visualsPresets.impact]
      soundId = "minecraft:entity.firework_rocket.twinkle"
      soundVolume = 0.8
      soundPitchMin = 0.9
      soundPitchMax = 1.2
      burstEnabled = true
      particlePreset = "FIREWORK"
      soundEnabled = true
      particleCount = 13
      spread = 0.4

Visuals Presets Configuration

An Array of visuals presets. Each preset defines the visuals for a falling star event.

particlesPerEmission

The number of particles emitted per emission during the falling star event. This value determines the visual density of the falling star’s particle effects.

• Type: Integer
• Default: 2

fallDistance

The distance in blocks that the falling star will travel before impacting the ground. This value determines how high the falling star starts from.

• Type: Integer
• Default: 10

particlePreset

The unique identifier for the particle preset used for the falling star’s particle effects.

• Type: Enum (String)
• Default: "END_ROD"

Allowed Values:

• "ASH" - Ash particles
• "GLOW" - Glow particles
• "END_ROD" - End rod particles
• "FIREWORK" - Firework particles

visualsId

The unique identifier for the visuals preset. This ID is used to reference the preset in other configuration files.

• Type: String
• Default: "base"

emissionIntervalTicks

The interval in ticks (20 ticks = 1 second) between particle emissions during the falling star event. This value determines how frequently particles are emitted.

• Type: Integer
• Default: 3

enabled

A boolean value indicating whether the visuals preset is enabled. If set to false, the preset will not be used in the falling star event.

• Type: Boolean
• Default: true

Travel Sound Configuration

Contains the travel sound configuration settings for the visuals preset, which define the sound effects played while the falling star is in motion.

volume

The volume of the travel sound effect. This value determines how loud the sound is when played.

• Type: Float
• Default: 0.12

pitchMax

The maximum pitch of the travel sound effect. This value determines the highest pitch that can be played for the sound.

• Type: Float
• Default: 1.7

pitchMin

The minimum pitch of the travel sound effect. This value determines the lowest pitch that can be played for the sound.

• Type: Float
• Default: 1.3

id

The unique identifier for the travel sound effect. This ID corresponds to the sound’s registry name in Minecraft.

• Type: String
• Default: "minecraft:entity.phantom.flap"

intervalTicks

The interval in ticks (20 ticks = 1 second) between travel sound effects during the falling star event. This value determines how frequently the sound is played.

• Type: Integer
• Default: 12

Impact Configuration

Contains the impact configuration settings for the visuals preset, which define the sound and particle effects played when the falling star impacts the ground.

soundId

The unique identifier for the impact sound effect. This ID corresponds to the sound’s registry name in Minecraft.

• Type: String
• Default: "minecraft:entity.firework_rocket.twinkle"

soundVolume

The volume of the impact sound effect. This value determines how loud the sound is when played.

• Type: Float
• Default: 0.8

soundPitchMin

The minimum pitch of the impact sound effect. This value determines the lowest pitch that can be played for the sound.

• Type: Float
• Default: 0.9

soundPitchMax

The maximum pitch of the impact sound effect. This value determines the highest pitch that can be played for the sound.

• Type: Float
• Default: 1.2

burstEnabled

A boolean value indicating whether a particle burst effect is enabled upon impact. If set to true, a burst of particles will be emitted when the falling star impacts the ground.

• Type: Boolean
• Default: true

particlePreset

The unique identifier for the particle preset used for the impact particle effects.

• Type: Enum (String)
• Default: "FIREWORK"

Allowed Values:

• "ASH" - Ash particles
• "GLOW" - Glow particles
• "END_ROD" - End rod particles
• "FIREWORK" - Firework particles

soundEnabled

A boolean value indicating whether the impact sound effect is enabled. If set to true, the impact sound will be played when the falling star impacts the ground.

• Type: Boolean
• Default: true

particleCount

The number of particles emitted during the impact particle burst effect. This value determines the visual density of the impact’s particle effects.

• Type: Integer
• Default: 13

spread

The spread of the impact particle burst effect. This value determines how far apart the particles are emitted from the impact point.

• Type: Float
• Default: 0.4