Difference between revisions of "Server config"

From AAGRINDER wiki
Jump to navigationJump to search
imported>Maze
m
(Update to current set of configuration options)
Line 1: Line 1:
−
The AAGRINDER server has a number of settings, which can be found in the file ''server-properties.json''. This file is created when the server is first started, and it is filled with default values. If the file already exists when the server is started, its contents are read and interpreted. In case any settings are missing, default values are added to the file automatically.
+
The AAGRINDER server has a number of settings, which can be found in the file ''config.json''. This file is created when the server is first started, and it is filled with default values. If the file already exists when the server is started, its contents are read and interpreted. In case any settings are missing, default values are added to the file automatically.
  
 
The following table lists all the settings, their default values and their explanations.
 
The following table lists all the settings, their default values and their explanations.
Line 8: Line 8:
 
| level_name || "world" || The name of the directory where the world will be saved.
 
| level_name || "world" || The name of the directory where the world will be saved.
 
|-
 
|-
−
| level_seed || A random value between 0 and 65535 || The seed, which will be used for [[terrain generation]].
+
| level_seed || Random value (0 - 65535) || The seed, which will be used for [[terrain generation]].
 
|-
 
|-
 
| generate_structures || true || Whether or not structures should be generated.
 
| generate_structures || true || Whether or not structures should be generated.
Line 16: Line 16:
 
| load_distance || 1 || The distance (in chunks) in which chunks are loaded around the player.
 
| load_distance || 1 || The distance (in chunks) in which chunks are loaded around the player.
 
|-
 
|-
−
| unload_distance || 2 || The distance (in chunks), beyond which chunks are unloaded.
+
| enable_unloading || true || Whether chunks should be unloaded server-side when not needed.
 +
|-
 +
| unload_distance || 2 || The distance (in chunks), beyond which chunks are unloaded on client & server.
 
|-
 
|-
 
| gamemode || 0 || The default gamemode on this server.
 
| gamemode || 0 || The default gamemode on this server.
Line 25: Line 27:
 
|-
 
|-
 
| restrict_to_localhost || false || Whether only localhost should be allowed to connect to this server.
 
| restrict_to_localhost || false || Whether only localhost should be allowed to connect to this server.
 +
|-
 +
| allow_registration || true || Whether registration should be publicly available.
 +
|-
 +
| enable_autosave || true || Whether the world should be saved periodically.
 +
|-
 +
| autosave_minutes || 120 || The interval for automatic saving.
 
|-
 
|-
 
| max_players || 42 || The number of players that are allowed to play at the same time.
 
| max_players || 42 || The number of players that are allowed to play at the same time.
 
|-
 
|-
−
| database_host || "localhost" || The address of the server on which the database is running.
+
| matrix_room_id || "" || the ID of the (optionally) bridged Matrix room.
 +
|-
 +
| matrix_homeserver_url || "" || Your Matrix homeserver URL.
 +
|-
 +
| matrix_bot_enabled || false || Whether the Matrix bridge bot should be enabled.
 +
|-
 +
| matrix_bot_access_token || "" || The access token for your Matrix bot account.
 +
|-
 +
| matrix_appservice_enabled || false || Whether the Matrix appservice bridge should be enabled.
 
|-
 
|-
−
| database_username || "root" || The username which should be used for connecting to the database.
+
| matrix_appservice_id || "aagrinder" || The desired ID for the Matrix appservice.
 
|-
 
|-
−
| database_password || "" || The password which should be used for connecting to the database.
+
| matrix_appservice_url || "http://localhost:8433" || The URL on which this appservice will be accessible from your Matrix server.
 
|-
 
|-
−
| database_name || "aagrinder" || The name of the database which should be used.
+
| matrix_appservice_domain || "example.org" || The domain for the Matrix server.
 
|-
 
|-
−
| debug_server || false || Whether debug logs should be kept on the server (warning: ram fills very fast in debug mode).
+
| matrix_appservice_bindaddress || "localhost" || The host on which this appservice will be accessible from your Matrix server.
 
|-
 
|-
−
| insecure_mode || false || Whether passwords should be ignored.
+
| matrix_appservice_port || 8433 || The port on which this appservice will be accessible from your Matrix server.
 
|-
 
|-
−
| authorization || true || Whether ''admins.txt'' should be checked.
+
| authorization || true || Whether admin.txt should be checked.
 
|-
 
|-
 
| allow_sudo || false || Whether the ''/sudo'' command should be allowed for the users specified in the file ''sudo.txt''.
 
| allow_sudo || false || Whether the ''/sudo'' command should be allowed for the users specified in the file ''sudo.txt''.
 
|-
 
|-
 
| enable_server_log || true || Whether a log of logins, messages and commands should be kept.
 
| enable_server_log || true || Whether a log of logins, messages and commands should be kept.
 +
|-
 +
| debug_server || false || Whether additional debug features should be enabled (increases network load)
 +
|-
 +
| enable_debug_log || false || Whether a log of all events should be kept (huge ram usage!)
 +
|-
 +
| enable_autologin || false || Whether the login screen should be skipped.
 +
|-
 +
| autologin_name || "user" || The name to log in as if autologin is enabled.
 +
|-
 +
| multithread || 4 || The number of threads to use for terrain generation.
 +
|-
 +
| welcome_message || "" || A message that will be displayed after login.
 
|}
 
|}

Revision as of 21:24, 14 August 2022

The AAGRINDER server has a number of settings, which can be found in the file config.json. This file is created when the server is first started, and it is filled with default values. If the file already exists when the server is started, its contents are read and interpreted. In case any settings are missing, default values are added to the file automatically.

The following table lists all the settings, their default values and their explanations.

Setting name Default value Explanation
level_name "world" The name of the directory where the world will be saved.
level_seed Random value (0 - 65535) The seed, which will be used for terrain generation.
generate_structures true Whether or not structures should be generated.
spawn_monsters true Whether or not monsters should spawn on this server.
load_distance 1 The distance (in chunks) in which chunks are loaded around the player.
enable_unloading true Whether chunks should be unloaded server-side when not needed.
unload_distance 2 The distance (in chunks), beyond which chunks are unloaded on client & server.
gamemode 0 The default gamemode on this server.
allow_home true Whether the /home command is allowed.
server_port 8080 The port on which the server should run.
restrict_to_localhost false Whether only localhost should be allowed to connect to this server.
allow_registration true Whether registration should be publicly available.
enable_autosave true Whether the world should be saved periodically.
autosave_minutes 120 The interval for automatic saving.
max_players 42 The number of players that are allowed to play at the same time.
matrix_room_id "" the ID of the (optionally) bridged Matrix room.
matrix_homeserver_url "" Your Matrix homeserver URL.
matrix_bot_enabled false Whether the Matrix bridge bot should be enabled.
matrix_bot_access_token "" The access token for your Matrix bot account.
matrix_appservice_enabled false Whether the Matrix appservice bridge should be enabled.
matrix_appservice_id "aagrinder" The desired ID for the Matrix appservice.
matrix_appservice_url "http://localhost:8433" The URL on which this appservice will be accessible from your Matrix server.
matrix_appservice_domain "example.org" The domain for the Matrix server.
matrix_appservice_bindaddress "localhost" The host on which this appservice will be accessible from your Matrix server.
matrix_appservice_port 8433 The port on which this appservice will be accessible from your Matrix server.
authorization true Whether admin.txt should be checked.
allow_sudo false Whether the /sudo command should be allowed for the users specified in the file sudo.txt.
enable_server_log true Whether a log of logins, messages and commands should be kept.
debug_server false Whether additional debug features should be enabled (increases network load)
enable_debug_log false Whether a log of all events should be kept (huge ram usage!)
enable_autologin false Whether the login screen should be skipped.
autologin_name "user" The name to log in as if autologin is enabled.
multithread 4 The number of threads to use for terrain generation.
welcome_message "" A message that will be displayed after login.
Retrieved from "https://wiki.aagrinder.xyz/index.php?title=Server_config&oldid=44806"