Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Aurora.general.enable

Enable the localhost server [default: false]

Type: boolean

Default:

false

Aurora.general.port

Webserver Port ID [range: 1024 ~ 65535, default: 48574]

Type: signed integer

Default:

48574

Aurora.pages.command_list_page

Enable the command list page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: ENABLED]

Type: string

Default:

"ENABLED"

Aurora.pages.modlist_excluded_mods

Exclude mods from the modlist. [default: ]

Type: list of string

Default:

[ ]

Aurora.pages.modlist_page

Enable the modlist page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: ENABLED]

Type: string

Default:

"ENABLED"

Aurora.pages.permission_list_page

Enable the permission list page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: ENABLED]

Type: string

Default:

"ENABLED"

Aurora.pages.player_list_json

Enable the playerlist json page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: ENABLED]

Type: string

Default:

"ENABLED"

Aurora.pages.player_list_table

Enable the playerlist table page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: ENABLED]

Type: string

Default:

"ENABLED"

Aurora.pages.player_rank_page

Enable the player rank page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: REQUIRES_AUTH]

Type: string

Default:

"REQUIRES_AUTH"

Aurora.pages.world_info_json

Enable the world info page. Possible values: [ENABLED, REQUIRES_AUTH, DISABLED] [default: ENABLED]

Type: string

Default:

"ENABLED"

ServerUtilities.afk.enabled

Enables afk timer. [default: true]

Type: boolean

Default:

true

ServerUtilities.afk.enabled_singleplayer

Enables afk timer in singleplayer. [default: true]

Type: boolean

Default:

true

ServerUtilities.afk.notification_timer

After how much time it will display notification to all players. [default: 5m]

Type: string

Default:

"5m"

ServerUtilities.auto_shutdown.enabled

Enables auto-shutdown. [default: false]

Type: boolean

Default:

false

ServerUtilities.auto_shutdown.enabled_singleplayer

Enables auto-shutdown in singleplayer worlds. [default: false]

Type: boolean

Default:

false

ServerUtilities.auto_shutdown.times

Server will automatically shut down when system time matches a value. Format: HH:MM. [default: [04:00], [16:00]]

Type: list of string

Default:

[
  "04:00"
  "16:00"
]

ServerUtilities.backups.enable_backups

Enables backups. [default: true]

Type: boolean

Default:

true

ServerUtilities.backups.additional_backup_files

List of additional paths to include in backup. Use / as separator, * as wildcard, $WORLDNAME for save name.

Type: list of string

Default:

[
  "journeymap/data/sp/$WORLDNAME/**"
  "TCNodeTracker/$WORLDNAME/**"
  "saves/NEI/global/**"
  "saves/NEI/local/$WORLDNAME/**"
  "visualprospecting/client/*/$WORLDNAME_*/**"
  "visualprospecting/server/$WORLDNAME_*/**"
]

ServerUtilities.backups.backup_folder_path

Path to backups folder. [default: ./backups/]

Type: string

Default:

"./backups/"

ServerUtilities.backups.backup_timer

Time between backups in hours. [range: 0.0 ~ max, default: 0.5]

Type: string

Default:

"0.5"

ServerUtilities.backups.backups_to_keep

Number of backup files to keep before deleting old ones. [range: 1 ~ 2147483647, default: 12]

Type: signed integer

Default:

12

ServerUtilities.backups.compression_level

How much the backup file will be compressed. 0 = uncompressed, 1 = best speed, 9 = smallest. [range: 0 ~ 9, default: 1]

Type: signed integer

Default:

1

ServerUtilities.backups.delete_custom_name_backups

Delete backups that have a custom name set through /backup start <name> [default: true]

Type: boolean

Default:

true

ServerUtilities.backups.display_file_size

Prints (current size | total size) when backup is done [default: true]

Type: boolean

Default:

true

ServerUtilities.backups.max_folder_size

Max size of backup folder in GB. 0 = disabled, use backups_to_keep instead. [range: 0 ~ 2147483647, default: 0]

Type: signed integer

Default:

0

ServerUtilities.backups.need_online_players

Backups won’t run if no players are online. [default: true]

Type: boolean

Default:

true

ServerUtilities.backups.only_backup_claimed_chunks

Only include claimed chunks in backup. Faster and smaller but unclaimed chunks will be unrecoverable. [default: false]

Type: boolean

Default:

false

ServerUtilities.backups.silent_backup

Silence backup notifications. [default: false]

Type: boolean

Default:

false

ServerUtilities.backups.use_separate_thread

Run backup in a separated thread (recommended) [default: true]

Type: boolean

Default:

true

ServerUtilities.chat.add_nickname_tilde

Adds ~ to player names that have changed nickname to prevent trolling. [default: false]

Type: boolean

Default:

false

ServerUtilities.chat.replace_tab_names

Replaces player names in the TAB screen with the names used in chat. [default: true]

Type: boolean

Default:

true

ServerUtilities.commands.back

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.backup

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.chunks

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.dump_chunkloaders

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.dump_permissions

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.dump_stats

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.fly

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.god

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.heal

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.home

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.inv

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.kickme

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.killall

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.leaderboard

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.mute

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.nbtedit

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.nick

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.pregen

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.ranks

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.“rec”

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.reload

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.rtp

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.seek_block

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.spawn

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.tpa

[default: true]

Type: boolean

Default:

false

ServerUtilities.commands.tpl

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.trash_can

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.vanish

[default: true]

Type: boolean

Default:

true

ServerUtilities.commands.warp

[default: true]

Type: boolean

Default:

false

ServerUtilities.debugging.dev_sidebar_buttons

See dev-only sidebar buttons. They probably don’t do anything. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.gui_widget_bounds

See GUI widget bounds when you hold B. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.log_chunkloading

Print a message in console every time a chunk is forced or unforced. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.log_config_editing

Log config editing. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.log_events

Log all events that extend EventBase. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.log_network

Log incoming and outgoing network messages. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.log_teleport

Log player teleporting. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.print_more_errors

Print more errors. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.print_more_info

Print more info. [default: false]

Type: boolean

Default:

false

ServerUtilities.debugging.special_commands

Enables special debug commands. [default: false]

Type: boolean

Default:

false

ServerUtilities.general.enable_pause_when_empty_property

Backports 1.20’s ‘pause-when-empty-seconds’ server property. [default: true]

Type: boolean

Default:

true

ServerUtilities.general.merge_offline_mode_players

Merges player profiles for players who logged in offline. Possible values: [TRUE, FALSE, DEFAULT] [default: TRUE]

Type: string

Default:

"TRUE"

ServerUtilities.login.enable_motd

Enables message of the day. [default: false]

Type: boolean

Default:

false

ServerUtilities.login.enable_starting_items

Enables starting items. [default: false]

Type: boolean

Default:

false

ServerUtilities.login.motd

Message of the day displayed when player joins. [default: [Hello player!]]

Type: list of string

Default:

[
  "\"Hello player!\""
]

ServerUtilities.login.starting_items

Items to give player when they first join. Format: ‘{id:“ID”,Count:X,Damage:X,tag:{}}’

Type: list of string

Default:

[ ]

ServerUtilities.ranks.enabled

Enables Ranks. [default: true]

Type: boolean

Default:

false

ServerUtilities.ranks.command_permissions

Add permissions for commands and allow them to be controlled by ranks. [default: true]

Type: boolean

Default:

true

ServerUtilities.ranks.override_chat

Adds chat colors/rank-specific syntax. [default: true]

Type: boolean

Default:

true

ServerUtilities.tasks.cleanup.enabled

Enables periodic removal of entities [default: false]

Type: boolean

Default:

false

ServerUtilities.tasks.cleanup.experience

Include experience orbs in cleanup [default: true]

Type: boolean

Default:

true

ServerUtilities.tasks.cleanup.hostiles

Include hostile mobs in cleanup [default: true]

Type: boolean

Default:

true

ServerUtilities.tasks.cleanup.interval

How often the cleanup should run in hours [range: 4.9E-324 ~ max, default: 2.0]

Type: floating point number

Default:

2.0

ServerUtilities.tasks.cleanup.items

Include items on the ground in cleanup [default: true]

Type: boolean

Default:

true

ServerUtilities.tasks.cleanup.passives

Include passive mobs in cleanup [default: false]

Type: boolean

Default:

false

ServerUtilities.tasks.cleanup.silent

Silence cleanup warning that are sent prior to starting [default: false]

Type: boolean

Default:

false

ServerUtilities.teams.autocreate_mp

Automatically creates a team for player on multiplayer, based on their username and with a random color. [default: false]

Type: boolean

Default:

false

ServerUtilities.teams.autocreate_sp

Automatically creates (or joins) a team on singleplayer/LAN with ID ‘singleplayer’. [default: true]

Type: boolean

Default:

true

ServerUtilities.teams.disable_teams

Disable teams entirely [default: false]

Type: boolean

Default:

false

ServerUtilities.teams.force_team_prefix

Forces player chat messages to be prefixed with their team name. [default: false]

Type: boolean

Default:

false

ServerUtilities.teams.grief_protection

Don’t allow other players to break blocks in claimed chunks [default: true]

Type: boolean

Default:

true

ServerUtilities.teams.hide_team_notification

Disable no team notification entirely. [default: false]

Type: boolean

Default:

false

ServerUtilities.teams.interaction_protection

Don’t allow other players to interact with blocks in claimed chunks [default: true]

Type: boolean

Default:

true

ServerUtilities.world.enable_explosions

Explosion setting. Possible values: [TRUE, FALSE, DEFAULT] [default: DEFAULT]

Type: string

Default:

"TRUE"

ServerUtilities.world.enable_player_sleeping_percentage

Enabled Player Sleeping Percentage to skip night. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.enable_pvp

PVP setting. Possible values: [TRUE, FALSE, DEFAULT] [default: DEFAULT]

Type: string

Default:

"TRUE"

ServerUtilities.world.blocked_claiming_dimensions

Dimensions where chunk claiming isn’t allowed. [default: []]

Type: list of signed integer

Default:

[ ]

ServerUtilities.world.chunk_claiming

Enables chunk claiming. [default: true]

Type: boolean

Default:

false

ServerUtilities.world.chunk_loading

Enables chunk loading. Has no effect if chunk_claiming is false. [default: true]

Type: boolean

Default:

true

ServerUtilities.world.disable_player_suffocation_damage

Disables player damage when they are stuck in walls. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.disabled_right_click_items

Items with right-click disabled. Syntax: modid:item:metadata or modid:item:*. [default: []]

Type: list of string

Default:

[ ]

ServerUtilities.world.forced_spawn_dimension_time

Locked time in ticks in spawn dimension. -1=disabled, 0=morning, 6000=noon, 12000=evening, 18000=midnight. [range: -1 ~ 23999, default: -1]

Type: signed integer

Default:

-1

ServerUtilities.world.forced_spawn_dimension_weather

Locked weather in spawn dimension. -1=disabled, 0=clear, 1=raining, 2=thunderstorm. [range: -1 ~ 2, default: -1]

Type: signed integer

Default:

-1

ServerUtilities.world.logging.enabled

Enables world logging. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.logging.block_broken

Logs block breaking. [default: true]

Type: boolean

Default:

false

ServerUtilities.world.logging.block_placed

Logs block placement. [default: true]

Type: boolean

Default:

false

ServerUtilities.world.logging.chat_enable

Enables chat logging. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.logging.entity_attacked

Logs player attacks on other players/entities. [default: true]

Type: boolean

Default:

false

ServerUtilities.world.logging.exclude_mob_entity

Exclude mobs from entity attack logging. [default: true]

Type: boolean

Default:

false

ServerUtilities.world.logging.include_creative_players

Includes creative players in world logging. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.logging.include_fake_players

Includes fake players in world logging. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.logging.item_clicked_in_air

Logs item clicking in air. [default: true]

Type: boolean

Default:

false

ServerUtilities.world.player_sleeping_percentage

Default Player Sleeping percentage gamerule initial value. [range: 0 ~ 100, default: 50]

Type: signed integer

Default:

50

ServerUtilities.world.rtp_max_distance

Max /rtp distance [range: 4.9E-324 ~ max, default: 100000.0]

Type: floating point number

Default:

100000.0

ServerUtilities.world.rtp_max_tries

Max tries /rtp does before failure. [range: -2147483648 ~ 2147483647, default: 200]

Type: signed integer

Default:

200

ServerUtilities.world.rtp_min_distance

Min /rtp distance [range: 4.9E-324 ~ max, default: 1000.0]

Type: floating point number

Default:

1000.0

ServerUtilities.world.safe_spawn

If true, explosions and hostile mobs in spawn area will be disabled, players won’t be able to attack each other in spawn area. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.show_playtime

Show play time in corner. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.spawn_area_in_sp

Enable spawn area in singleplayer. [default: false]

Type: boolean

Default:

false

ServerUtilities.world.spawn_dimension

Spawn dimension. Overworld by default. [range: -2147483648 ~ 2147483647, default: 0]

Type: signed integer

Default:

0

ServerUtilities.world.spawn_radius

Spawn radius. You must set spawn-protection in server.properties to 0! [range: -2147483648 ~ 2147483647, default: 0]

Type: signed integer

Default:

0

ServerUtilities.world.unload_erroring_chunks

Unloads erroring chunks if dimension isn’t loaded or some other problem occurs. [default: false]

Type: boolean

Default:

false