Skip to content

Configuration Guide

Jump to bottom
Kala edited this page Nov 10, 2025 · 5 revisions

Configuration Guide

⚠️ Beta Version Only

This configuration system is only available in v1.1.0-beta.

  • Stable v1.0.2: No configuration file. All settings are hardcoded.
  • Beta v1.1.0: Complete TOML configuration system documented on this page.

If you're using stable v1.0.2, this page does not apply. Settings are fixed at:

  • Distance: 75 blocks
  • Permissions: Level 0 (all players)
  • Interactions: Doors, trapdoors, gates only
  • All other settings: Default values

See Version Comparison to understand the differences.

Limited Spectator Beta uses a comprehensive TOML configuration file that controls every aspect of the spectator mode behavior. This guide explains every setting in detail.

Configuration File Location

Environment Path
Dedicated Server config/limitedspectator-common.toml
Single-Player/Client run/config/limitedspectator-common.toml
Development run/config/limitedspectator-common.toml

Hot-Reloading

All configuration changes can be applied without restarting:

/reload

This command reloads all configurations, including Limited Spectator settings.

Configuration Sections

📍 Movement Restrictions

Controls where and how far players can travel in spectator mode.

[movement]
  max_distance = 75.0
  allow_dimension_travel = false
  teleport_back_on_exceed = true
  reset_position_on_logout = true

max_distance

  • Type: Double
  • Default: 75.0
  • Range: -1.0 (unlimited) or > 0
  • Description: Maximum distance in blocks from the starting position

Players are teleported back when exceeding this distance. Set to -1 to allow unlimited travel.

Examples:

  • 50.0 - Tight restriction for small areas
  • 150.0 - Moderate freedom for larger bases
  • 500.0 - Wide area for exploring
  • -1.0 - No distance limit (not recommended for public servers)

allow_dimension_travel

  • Type: Boolean
  • Default: false
  • Description: Allow dimension changes (Nether, End, custom dimensions)

When false, players attempting to use portals or /tp to other dimensions will be blocked with a warning message.

Security Note: Enabling this can allow players to bypass distance limits by traveling through dimensions.

teleport_back_on_exceed

  • Type: Boolean
  • Default: true
  • Description: Teleport player back when exceeding distance, or just send a warning

When true, players are automatically teleported to their starting position. When false, only a warning message is shown.

reset_position_on_logout

  • Type: Boolean
  • Default: true
  • Description: Reset player position to starting point on logout

Prevents players from logging out at distant locations and logging back in outside the spectator area.

⚡ Player Abilities

Controls player capabilities and game mode behavior in spectator mode.

[abilities]
  enable_invulnerability = true
  enable_flight = true
  auto_start_flying = true
  spectator_gamemode = "ADVENTURE"

enable_invulnerability

  • Type: Boolean
  • Default: true
  • Description: Make players invulnerable to all damage

Recommended to keep true to prevent accidental deaths while spectating.

enable_flight

  • Type: Boolean
  • Default: true
  • Description: Allow flight in spectator mode

Core feature. Set to false if you want ground-only spectating (unusual).

auto_start_flying

  • Type: Boolean
  • Default: true
  • Description: Automatically start flying when entering spectator mode

When false, players must double-tap space to start flying manually.

spectator_gamemode

  • Type: String
  • Default: "ADVENTURE"
  • Options: "ADVENTURE" or "SPECTATOR"
  • Description: GameMode to use for spectator mode

ADVENTURE (default) - Uses Adventure mode with flight abilities. More compatible with other mods. SPECTATOR - Uses vanilla spectator mode. May bypass some restrictions.

⚠️ Warning: Using "SPECTATOR" may allow players to bypass restrictions like block clipping and dimension travel.

🎮 Interaction Restrictions

Granular control over what players can interact with.

[interactions]
  allow_pvp = false
  allow_mob_attacks = false
  allow_item_drop = false
  allow_item_pickup = false
  allow_block_breaking = false
  allow_block_placing = false
  interactable_blocks = [
    "minecraft:oak_door",
    "minecraft:iron_door",
    "minecraft:oak_trapdoor",
    "minecraft:iron_trapdoor",
    "minecraft:oak_fence_gate",
    "minecraft:spruce_fence_gate",
    "minecraft:birch_fence_gate",
    "minecraft:jungle_fence_gate",
    "minecraft:acacia_fence_gate",
    "minecraft:dark_oak_fence_gate",
    "minecraft:mangrove_fence_gate",
    "minecraft:cherry_fence_gate",
    "minecraft:bamboo_fence_gate",
    "minecraft:crimson_fence_gate",
    "minecraft:warped_fence_gate"
  ]

allow_pvp

  • Type: Boolean
  • Default: false
  • Description: Allow attacking other players

Set to true only if your server allows spectators to participate in PvP.

allow_mob_attacks

  • Type: Boolean
  • Default: false
  • Description: Allow attacking mobs

Enable if you want spectators to help with mob control.

allow_item_drop

  • Type: Boolean
  • Default: false
  • Description: Allow dropping items from inventory

Prevents spectators from transferring items to other players.

allow_item_pickup

  • Type: Boolean
  • Default: false
  • Description: Allow picking up items from the ground

Prevents spectators from collecting loot or resources.

allow_block_breaking

  • Type: Boolean
  • Default: false
  • Description: Allow breaking blocks

Enable only if you want spectators to modify the world.

allow_block_placing

  • Type: Boolean
  • Default: false
  • Description: Allow placing blocks

Enable only if you want spectators to build.

interactable_blocks

  • Type: String array
  • Default: Doors, trapdoors, fence gates
  • Description: List of block IDs that players can interact with

Players can right-click these blocks even in spectator mode. Useful for allowing door opening without full interaction privileges.

Common additions:

# Add buttons and levers
interactable_blocks = [
  # ... default doors/gates ...
  "minecraft:stone_button",
  "minecraft:oak_button",
  "minecraft:lever"
]
# Add pressure plates
interactable_blocks = [
  # ... default doors/gates ...
  "minecraft:stone_pressure_plate",
  "minecraft:heavy_weighted_pressure_plate"
]

Modded blocks: Use the full block ID, e.g., "create:copper_valve_handle"

🔑 Command Permissions

Controls who can use spectator commands.

[commands]
  spectator_command_permission_level = 0
  survival_command_permission_level = 0
  require_op_for_spectator = false

spectator_command_permission_level

  • Type: Integer
  • Default: 0
  • Range: 0-4
  • Description: Permission level required for /spectator command

Permission levels in Minecraft:

  • 0 - All players
  • 1 - Moderators (bypass spawn protection)
  • 2 - Operators (commands like /gamemode, /give)
  • 3 - Operators (commands like /ban, /kick)
  • 4 - Operators (commands like /stop, /op)

Recommended settings:

  • 0 - Open spectator mode for all players
  • 2 - Restrict to operators only
  • 4 - Restrict to console/high-level admins

survival_command_permission_level

  • Type: Integer
  • Default: 0
  • Range: 0-4
  • Description: Permission level required for /survival command

Usually kept at 0 to allow spectators to return to survival mode themselves.

require_op_for_spectator

  • Type: Boolean
  • Default: false
  • Description: Require operator status for spectator commands

When true, only players with OP status can use spectator commands, ignoring permission levels.

Use case: Enable this on public servers where you don't use permission levels but want to restrict spectator access to staff.

🖥️ Client & HUD Settings

Client-side visual experience settings.

[client]
  auto_hide_hud = true
  allow_f1_hud_toggle = true

auto_hide_hud

  • Type: Boolean
  • Default: true
  • Description: Automatically hide HUD when entering spectator mode

Provides a cleaner viewing experience without hotbar, health, etc.

Note: Only works if Limited Spectator is installed on the client.

allow_f1_hud_toggle

  • Type: Boolean
  • Default: true
  • Description: Allow F1 key to temporarily show HUD in spectator mode

When true, pressing F1 will toggle HUD visibility temporarily.

💬 Message Settings

Controls how messages are displayed to players.

[messages]
  use_action_bar_messages = true
  show_distance_warnings = true

use_action_bar_messages

  • Type: Boolean
  • Default: true
  • Description: Show messages in action bar (above hotbar) instead of chat

Action bar messages are less intrusive than chat messages.

When false, all messages appear in chat.

show_distance_warnings

  • Type: Boolean
  • Default: true
  • Description: Show warnings when approaching distance limit

Players receive warnings at 90% of max_distance:

  • Action bar: "Warning: You are reaching the distance limit!"
  • When exceeded: "You have exceeded the distance limit and were teleported back!"

Set to false for silent enforcement.

Configuration Examples

Example 1: Strict Server Configuration

For competitive servers where spectating should be highly restricted:

[movement]
  max_distance = 50.0
  allow_dimension_travel = false
  teleport_back_on_exceed = true
  reset_position_on_logout = true

[abilities]
  enable_invulnerability = true
  enable_flight = true
  auto_start_flying = true
  spectator_gamemode = "ADVENTURE"

[interactions]
  allow_pvp = false
  allow_mob_attacks = false
  allow_item_drop = false
  allow_item_pickup = false
  allow_block_breaking = false
  allow_block_placing = false
  interactable_blocks = []  # No interactions allowed

[commands]
  spectator_command_permission_level = 2  # Operators only
  survival_command_permission_level = 0
  require_op_for_spectator = true

[messages]
  use_action_bar_messages = true
  show_distance_warnings = true

Example 2: Cooperative/PvE Server

For cooperative servers where spectators can help a bit:

[movement]
  max_distance = 150.0
  allow_dimension_travel = false
  teleport_back_on_exceed = true
  reset_position_on_logout = true

[interactions]
  allow_pvp = false
  allow_mob_attacks = true  # Can help with mobs
  allow_item_drop = false
  allow_item_pickup = true  # Can collect loot
  allow_block_breaking = false
  allow_block_placing = false
  interactable_blocks = [
    "minecraft:oak_door",
    "minecraft:stone_button",
    "minecraft:lever"
  ]

[commands]
  spectator_command_permission_level = 0  # All players
  require_op_for_spectator = false

Example 3: Creative/Building Server

For creative servers where spectators need more freedom:

[movement]
  max_distance = 500.0
  allow_dimension_travel = true  # Can visit Nether/End
  teleport_back_on_exceed = false  # Just warn
  reset_position_on_logout = false

[interactions]
  allow_pvp = false
  allow_mob_attacks = true
  allow_item_drop = true
  allow_item_pickup = true
  allow_block_breaking = false  # Still prevent griefing
  allow_block_placing = false
  interactable_blocks = [
    "minecraft:oak_door",
    "minecraft:oak_button",
    "minecraft:lever",
    "minecraft:chest",
    "minecraft:barrel"
  ]

[commands]
  spectator_command_permission_level = 0
  require_op_for_spectator = false

Example 4: Testing/Development Server

For admins testing the server:

[movement]
  max_distance = -1.0  # Unlimited
  allow_dimension_travel = true
  teleport_back_on_exceed = false
  reset_position_on_logout = false

[interactions]
  allow_pvp = true
  allow_mob_attacks = true
  allow_item_drop = true
  allow_item_pickup = true
  allow_block_breaking = true
  allow_block_placing = true
  # All blocks interactable

[commands]
  spectator_command_permission_level = 0
  require_op_for_spectator = false

[messages]
  show_distance_warnings = false  # No warnings needed

Troubleshooting Configuration

Config not loading changes

  1. Ensure TOML syntax is correct (use a TOML validator)
  2. Run /reload after making changes
  3. Check logs/latest.log for config errors

Config file keeps resetting

The config regenerates if it's corrupted or has invalid values. Always backup before editing.

Commands not working after permission changes

Run /reload and rejoin the server for permission changes to take effect.

Next: Learn how to use Commands or explore Features in detail.

Clone this wiki locally