From f66c0b86b605a4c5146008905588d9a1e434d984 Mon Sep 17 00:00:00 2001 From: Smell of curry <75345244+smell-of-curry@users.noreply.github.com> Date: Thu, 11 Jul 2024 05:24:45 -0700 Subject: [PATCH] Added & re-ordered all Property Definitions to match current standards & Contributing Warning (#434) --- README.md | 44 ++++++++-- property-definitions.json | 172 ++++++++++++++++++++++++++++---------- 2 files changed, 164 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 58c7395..a1a5d1f 100644 --- a/README.md +++ b/README.md @@ -53,32 +53,62 @@ Typically, each property is configured instead by the UPPER_SNAKE_CASE equivalen - `GAMEMODE` - `FORCE_GAMEMODE` - `DIFFICULTY` -- `LEVEL_TYPE` - `ALLOW_CHEATS` - `MAX_PLAYERS` - `ONLINE_MODE` - `WHITE_LIST` +- `ALLOW_LIST` +- `SERVER_PORT` +- `SERVER_PORT_V6` +- `ENABLE_LAN_VISIBILITY` - `VIEW_DISTANCE` - `TICK_DISTANCE` - `PLAYER_IDLE_TIMEOUT` - `MAX_THREADS` - `LEVEL_NAME` - `LEVEL_SEED` +- `LEVEL_TYPE` - `DEFAULT_PLAYER_PERMISSION_LEVEL` - `TEXTUREPACK_REQUIRED` +- `CONTENT_LOG_FILE_ENABLED` +- `CONTENT_LOG_LEVEL` +- `CONTENT_LOG_CONSOLE_OUTPUT_ENABLED` +- `COMPRESSION_THRESHOLD` +- `COMPRESSION_ALGORITHM` - `SERVER_AUTHORITATIVE_MOVEMENT` +- `PLAYER_POSITION_ACCEPTANCE_THRESHOLD` - `PLAYER_MOVEMENT_SCORE_THRESHOLD` +- `PLAYER_MOVEMENT_ACTION_DIRECTION_THRESHOLD` - `PLAYER_MOVEMENT_DISTANCE_THRESHOLD` - `PLAYER_MOVEMENT_DURATION_THRESHOLD_IN_MS` - `CORRECT_PLAYER_MOVEMENT` -- `MSA_GAMERTAGS_ONLY` -- `ITEM_TRANSACTION_LOGGING_ENABLED` -- `DISABLE_CUSTOM_SKINS` -- `DISABLE_PERSONA` +- `SERVER_AUTHORITATIVE_BLOCK_BREAKING` +- `SERVER_AUTHORITATIVE_BLOCK_BREAKING_PICK_RANGE_SCALAR` - `CHAT_RESTRICTION` -- `OP_PERMISSION_LEVEL` -- `COMPRESSION_ALGORITHM` +- `DISABLE_PLAYER_INTERACTION` +- `CLIENT_SIDE_CHUNK_GENERATION_ENABLED` - `BLOCK_NETWORK_IDS_ARE_HASHES` +- `DISABLE_PERSONA` +- `DISABLE_CUSTOM_SKINS` +- `SERVER_BUILD_RADIUS_RATIO` +- `ALLOW_OUTBOUND_SCRIPT_DEBUGGING` +- `ALLOW_INBOUND_SCRIPT_DEBUGGING` +- `FORCE_INBOUND_DEBUG_PORT` +- `SCRIPT_DEBUGGER_AUTO_ATTACH` +- `SCRIPT_DEBUGGER_AUTO_ATTACH_CONNECT_ADDRESS` +- `SCRIPT_WATCHDOG_ENABLE` +- `SCRIPT_WATCHDOG_ENABLE_EXCEPTION_HANDLING` +- `SCRIPT_WATCHDOG_ENABLE_SHUTDOWN` +- `SCRIPT_WATCHDOG_HANG_EXCEPTION` +- `SCRIPT_WATCHDOG_HANG_THRESHOLD` +- `SCRIPT_WATCHDOG_SPIKE_THRESHOLD` +- `SCRIPT_WATCHDOG_SLOW_THRESHOLD` +- `SCRIPT_WATCHDOG_MEMORY_WARNING` +- `SCRIPT_WATCHDOG_MEMORY_LIMIT` +- `OP_PERMISSION_LEVEL` +- `EMIT_SERVER_TELEMETRY` +- `MSA_GAMERTAGS_ONLY` +- `ITEM_TRANSACTION_LOGGING_ENABLED` For example, to configure a flat, creative server instead of the default use: diff --git a/property-definitions.json b/property-definitions.json index dd7858e..d0f4f3f 100644 --- a/property-definitions.json +++ b/property-definitions.json @@ -2,12 +2,6 @@ "server-name": { "env": "SERVER_NAME" }, - "server-port": { - "env": "SERVER_PORT" - }, - "server-portv6": { - "env": "SERVER_PORT_V6" - }, "gamemode": { "env": "GAMEMODE", "allowed": ["survival", "creative", "adventure"], @@ -31,15 +25,6 @@ "3": "hard" } }, - "level-type": { - "env": "LEVEL_TYPE", - "allowed": ["DEFAULT", "FLAT", "LEGACY"], - "mappings": { - "flat": "FLAT", - "legacy": "LEGACY", - "default": "DEFAULT" - } - }, "allow-cheats": { "env": "ALLOW_CHEATS", "allowed": ["true", "false"] @@ -53,12 +38,23 @@ }, "white-list": { "env": "WHITE_LIST", - "allowed": ["true", "false"] + "allowed": ["true", "false"], + "deprecated": "This property is deprecated. Use 'allow-list' instead." }, "allow-list": { "env": "ALLOW_LIST", "allowed": ["true", "false"] }, + "server-port": { + "env": "SERVER_PORT" + }, + "server-portv6": { + "env": "SERVER_PORT_V6" + }, + "enable-lan-visibility": { + "env": "ENABLE_LAN_VISIBILITY", + "allowed": ["true", "false"] + }, "view-distance": { "env": "VIEW_DISTANCE" }, @@ -71,15 +67,21 @@ "max-threads": { "env": "MAX_THREADS" }, - "compression-threshold": { - "env": "COMPRESSION_THRESHOLD" - }, "level-name": { "env": "LEVEL_NAME" }, "level-seed": { "env": "LEVEL_SEED" }, + "level-type": { + "env": "LEVEL_TYPE", + "allowed": ["DEFAULT", "FLAT", "LEGACY"], + "mappings": { + "flat": "FLAT", + "legacy": "LEGACY", + "default": "DEFAULT" + } + }, "default-player-permission-level": { "env": "DEFAULT_PLAYER_PERMISSION_LEVEL", "allowed": ["visitor", "member", "operator"] @@ -88,6 +90,25 @@ "env": "TEXTUREPACK_REQUIRED", "allowed": ["true", "false"] }, + "content-log-file-enabled": { + "env": "CONTENT_LOG_FILE_ENABLED", + "allowed": ["true", "false"] + }, + "content-log-level": { + "env": "CONTENT_LOG_LEVEL", + "allowed": ["verbose", "info", "warning", "error"] + }, + "content-log-console-output-enabled": { + "env": "CONTENT_LOG_CONSOLE_OUTPUT_ENABLED", + "allowed": ["true", "false"] + }, + "compression-threshold": { + "env": "COMPRESSION_THRESHOLD" + }, + "compression-algorithm": { + "env": "COMPRESSION_ALGORITHM", + "allowed": ["zlib", "snappy"] + }, "server-authoritative-movement": { "env": "SERVER_AUTHORITATIVE_MOVEMENT", "allowed": ["server-auth", "client-auth", "server-auth-with-rewind"], @@ -96,13 +117,15 @@ "false": "client-auth" } }, - "server-authoritative-block-breaking": { - "env": "SERVER_AUTHORITATIVE_BLOCK_BREAKING", - "allowed": ["true", "false"] + "player-position-acceptance-threshold": { + "env": "PLAYER_POSITION_ACCEPTANCE_THRESHOLD" }, "player-movement-score-threshold": { "env": "PLAYER_MOVEMENT_SCORE_THRESHOLD" }, + "player-movement-action-direction-threshold": { + "env": "PLAYER_MOVEMENT_ACTION_DIRECTION_THRESHOLD" + }, "player-movement-distance-threshold": { "env": "PLAYER_MOVEMENT_DISTANCE_THRESHOLD" }, @@ -113,48 +136,107 @@ "env": "CORRECT_PLAYER_MOVEMENT", "allowed": ["true", "false"] }, - "emit-server-telemetry": { - "env": "EMIT_SERVER_TELEMETRY", + "server-authoritative-block-breaking": { + "env": "SERVER_AUTHORITATIVE_BLOCK_BREAKING", "allowed": ["true", "false"] }, - "enable-lan-visibility": { - "env": "ENABLE_LAN_VISIBILITY", + "server-authoritative-block-breaking-pick-range-scalar": { + "env": "SERVER_AUTHORITATIVE_BLOCK_BREAKING_PICK_RANGE_SCALAR" + }, + "chat-restriction": { + "env": "CHAT_RESTRICTION", + "allowed": ["None", "Dropped", "Disabled"], + "mappings": { + "none": "none", + "dropped": "Dropped", + "disabled": "Disabled" + } + }, + "disable-player-interaction": { + "env": "DISABLE_PLAYER_INTERACTION", "allowed": ["true", "false"] }, - "msa-gamertags-only": { - "env": "MSA_GAMERTAGS_ONLY", + "client-side-chunk-generation-enabled": { + "env": "CLIENT_SIDE_CHUNK_GENERATION_ENABLED", "allowed": ["true", "false"] }, - "item-transaction-logging-enabled": { - "env": "ITEM_TRANSACTION_LOGGING_ENABLED", + "block-network-ids-are-hashes": { + "env": "BLOCK_NETWORK_IDS_ARE_HASHES", + "allowed": ["true", "false"] + }, + "disable-persona": { + "env": "DISABLE_PERSONA", "allowed": ["true", "false"] }, "disable-custom-skins": { "env": "DISABLE_CUSTOM_SKINS", "allowed": ["true", "false"] }, - "disable-persona": { - "env": "DISABLE_PERSONA", + "server-build-radius-ratio": { + "env": "SERVER_BUILD_RADIUS_RATIO" + }, + "allow-outbound-script-debugging": { + "env": "ALLOW_OUTBOUND_SCRIPT_DEBUGGING", "allowed": ["true", "false"] }, - "chat-restriction": { - "env": "CHAT_RESTRICTION", - "allowed": ["None", "Dropped", "Disabled"], - "mappings": { - "none": "none", - "dropped": "Dropped", - "disabled": "Disabled" - } + "allow-inbound-script-debugging": { + "env": "ALLOW_INBOUND_SCRIPT_DEBUGGING", + "allowed": ["true", "false"] + }, + "force-inbound-debug-port": { + "env": "FORCE_INBOUND_DEBUG_PORT" + }, + "script-debugger-auto-attach": { + "env": "SCRIPT_DEBUGGER_AUTO_ATTACH", + "allowed": ["disabled", "connect", "listen"] + }, + "script-debugger-auto-attach-connect-address": { + "env": "SCRIPT_DEBUGGER_AUTO_ATTACH_CONNECT_ADDRESS" + }, + "script-watchdog-enable": { + "env": "SCRIPT_WATCHDOG_ENABLE", + "allowed": ["true", "false"] + }, + "script-watchdog-enable-exception-handling": { + "env": "SCRIPT_WATCHDOG_ENABLE_EXCEPTION_HANDLING", + "allowed": ["true", "false"] + }, + "script-watchdog-enable-shutdown": { + "env": "SCRIPT_WATCHDOG_ENABLE_SHUTDOWN", + "allowed": ["true", "false"] + }, + "script-watchdog-hang-exception": { + "env": "SCRIPT_WATCHDOG_HANG_EXCEPTION", + "allowed": ["true", "false"] + }, + "script-watchdog-hang-threshold": { + "env": "SCRIPT_WATCHDOG_HANG_THRESHOLD" + }, + "script-watchdog-spike-threshold": { + "env": "SCRIPT_WATCHDOG_SPIKE_THRESHOLD" + }, + "script-watchdog-slow-threshold": { + "env": "SCRIPT_WATCHDOG_SLOW_THRESHOLD" + }, + "script-watchdog-memory-warning": { + "env": "SCRIPT_WATCHDOG_MEMORY_WARNING" + }, + "script-watchdog-memory-limit": { + "env": "SCRIPT_WATCHDOG_MEMORY_LIMIT" }, "op-permission-level": { "env": "OP_PERMISSION_LEVEL" }, - "compression-algorithm": { - "env": "COMPRESSION_ALGORITHM", - "allowed": ["zlib", "snappy"] + "emit-server-telemetry": { + "env": "EMIT_SERVER_TELEMETRY", + "allowed": ["true", "false"] }, - "block-network-ids-are-hashes": { - "env": "BLOCK_NETWORK_IDS_ARE_HASHES", + "msa-gamertags-only": { + "env": "MSA_GAMERTAGS_ONLY", + "allowed": ["true", "false"] + }, + "item-transaction-logging-enabled": { + "env": "ITEM_TRANSACTION_LOGGING_ENABLED", "allowed": ["true", "false"] } }