Added & re-ordered all Property Definitions to match current standards & Contributing Warning (#434)

This commit is contained in:
Smell of curry authored and GitHub committed 2024-07-11 07:24:45 -05:00
1 parent 8960fe59a0
commit f66c0b86b6
2 files changed
+167 -55

No files matched your search

+37 -7
View File
@@ -53,32 +53,62 @@ Typically, each property is configured instead by the UPPER_SNAKE_CASE equivalen
- `GAMEMODE` - `GAMEMODE`
- `FORCE_GAMEMODE` - `FORCE_GAMEMODE`
- `DIFFICULTY` - `DIFFICULTY`
- `LEVEL_TYPE`
- `ALLOW_CHEATS` - `ALLOW_CHEATS`
- `MAX_PLAYERS` - `MAX_PLAYERS`
- `ONLINE_MODE` - `ONLINE_MODE`
- `WHITE_LIST` - `WHITE_LIST`
- `ALLOW_LIST`
- `SERVER_PORT`
- `SERVER_PORT_V6`
- `ENABLE_LAN_VISIBILITY`
- `VIEW_DISTANCE` - `VIEW_DISTANCE`
- `TICK_DISTANCE` - `TICK_DISTANCE`
- `PLAYER_IDLE_TIMEOUT` - `PLAYER_IDLE_TIMEOUT`
- `MAX_THREADS` - `MAX_THREADS`
- `LEVEL_NAME` - `LEVEL_NAME`
- `LEVEL_SEED` - `LEVEL_SEED`
- `LEVEL_TYPE`
- `DEFAULT_PLAYER_PERMISSION_LEVEL` - `DEFAULT_PLAYER_PERMISSION_LEVEL`
- `TEXTUREPACK_REQUIRED` - `TEXTUREPACK_REQUIRED`
- `CONTENT_LOG_FILE_ENABLED`
- `CONTENT_LOG_LEVEL`
- `CONTENT_LOG_CONSOLE_OUTPUT_ENABLED`
- `COMPRESSION_THRESHOLD`
- `COMPRESSION_ALGORITHM`
- `SERVER_AUTHORITATIVE_MOVEMENT` - `SERVER_AUTHORITATIVE_MOVEMENT`
- `PLAYER_POSITION_ACCEPTANCE_THRESHOLD`
- `PLAYER_MOVEMENT_SCORE_THRESHOLD` - `PLAYER_MOVEMENT_SCORE_THRESHOLD`
- `PLAYER_MOVEMENT_ACTION_DIRECTION_THRESHOLD`
- `PLAYER_MOVEMENT_DISTANCE_THRESHOLD` - `PLAYER_MOVEMENT_DISTANCE_THRESHOLD`
- `PLAYER_MOVEMENT_DURATION_THRESHOLD_IN_MS` - `PLAYER_MOVEMENT_DURATION_THRESHOLD_IN_MS`
- `CORRECT_PLAYER_MOVEMENT` - `CORRECT_PLAYER_MOVEMENT`
- `SERVER_AUTHORITATIVE_BLOCK_BREAKING`
- `SERVER_AUTHORITATIVE_BLOCK_BREAKING_PICK_RANGE_SCALAR`
- `CHAT_RESTRICTION`
- `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` - `MSA_GAMERTAGS_ONLY`
- `ITEM_TRANSACTION_LOGGING_ENABLED` - `ITEM_TRANSACTION_LOGGING_ENABLED`
- `DISABLE_CUSTOM_SKINS`
- `DISABLE_PERSONA`
- `CHAT_RESTRICTION`
- `OP_PERMISSION_LEVEL`
- `COMPRESSION_ALGORITHM`
- `BLOCK_NETWORK_IDS_ARE_HASHES`
For example, to configure a flat, creative server instead of the default use: For example, to configure a flat, creative server instead of the default use:
+130 -48
View File
@@ -2,12 +2,6 @@
"server-name": { "server-name": {
"env": "SERVER_NAME" "env": "SERVER_NAME"
}, },
"server-port": {
"env": "SERVER_PORT"
},
"server-portv6": {
"env": "SERVER_PORT_V6"
},
"gamemode": { "gamemode": {
"env": "GAMEMODE", "env": "GAMEMODE",
"allowed": ["survival", "creative", "adventure"], "allowed": ["survival", "creative", "adventure"],
@@ -31,15 +25,6 @@
"3": "hard" "3": "hard"
} }
}, },
"level-type": {
"env": "LEVEL_TYPE",
"allowed": ["DEFAULT", "FLAT", "LEGACY"],
"mappings": {
"flat": "FLAT",
"legacy": "LEGACY",
"default": "DEFAULT"
}
},
"allow-cheats": { "allow-cheats": {
"env": "ALLOW_CHEATS", "env": "ALLOW_CHEATS",
"allowed": ["true", "false"] "allowed": ["true", "false"]
@@ -53,12 +38,23 @@
}, },
"white-list": { "white-list": {
"env": "WHITE_LIST", "env": "WHITE_LIST",
"allowed": ["true", "false"] "allowed": ["true", "false"],
"deprecated": "This property is deprecated. Use 'allow-list' instead."
}, },
"allow-list": { "allow-list": {
"env": "ALLOW_LIST", "env": "ALLOW_LIST",
"allowed": ["true", "false"] "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": { "view-distance": {
"env": "VIEW_DISTANCE" "env": "VIEW_DISTANCE"
}, },
@@ -71,15 +67,21 @@
"max-threads": { "max-threads": {
"env": "MAX_THREADS" "env": "MAX_THREADS"
}, },
"compression-threshold": {
"env": "COMPRESSION_THRESHOLD"
},
"level-name": { "level-name": {
"env": "LEVEL_NAME" "env": "LEVEL_NAME"
}, },
"level-seed": { "level-seed": {
"env": "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": { "default-player-permission-level": {
"env": "DEFAULT_PLAYER_PERMISSION_LEVEL", "env": "DEFAULT_PLAYER_PERMISSION_LEVEL",
"allowed": ["visitor", "member", "operator"] "allowed": ["visitor", "member", "operator"]
@@ -88,6 +90,25 @@
"env": "TEXTUREPACK_REQUIRED", "env": "TEXTUREPACK_REQUIRED",
"allowed": ["true", "false"] "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": { "server-authoritative-movement": {
"env": "SERVER_AUTHORITATIVE_MOVEMENT", "env": "SERVER_AUTHORITATIVE_MOVEMENT",
"allowed": ["server-auth", "client-auth", "server-auth-with-rewind"], "allowed": ["server-auth", "client-auth", "server-auth-with-rewind"],
@@ -96,13 +117,15 @@
"false": "client-auth" "false": "client-auth"
} }
}, },
"server-authoritative-block-breaking": { "player-position-acceptance-threshold": {
"env": "SERVER_AUTHORITATIVE_BLOCK_BREAKING", "env": "PLAYER_POSITION_ACCEPTANCE_THRESHOLD"
"allowed": ["true", "false"]
}, },
"player-movement-score-threshold": { "player-movement-score-threshold": {
"env": "PLAYER_MOVEMENT_SCORE_THRESHOLD" "env": "PLAYER_MOVEMENT_SCORE_THRESHOLD"
}, },
"player-movement-action-direction-threshold": {
"env": "PLAYER_MOVEMENT_ACTION_DIRECTION_THRESHOLD"
},
"player-movement-distance-threshold": { "player-movement-distance-threshold": {
"env": "PLAYER_MOVEMENT_DISTANCE_THRESHOLD" "env": "PLAYER_MOVEMENT_DISTANCE_THRESHOLD"
}, },
@@ -113,29 +136,12 @@
"env": "CORRECT_PLAYER_MOVEMENT", "env": "CORRECT_PLAYER_MOVEMENT",
"allowed": ["true", "false"] "allowed": ["true", "false"]
}, },
"emit-server-telemetry": { "server-authoritative-block-breaking": {
"env": "EMIT_SERVER_TELEMETRY", "env": "SERVER_AUTHORITATIVE_BLOCK_BREAKING",
"allowed": ["true", "false"] "allowed": ["true", "false"]
}, },
"enable-lan-visibility": { "server-authoritative-block-breaking-pick-range-scalar": {
"env": "ENABLE_LAN_VISIBILITY", "env": "SERVER_AUTHORITATIVE_BLOCK_BREAKING_PICK_RANGE_SCALAR"
"allowed": ["true", "false"]
},
"msa-gamertags-only": {
"env": "MSA_GAMERTAGS_ONLY",
"allowed": ["true", "false"]
},
"item-transaction-logging-enabled": {
"env": "ITEM_TRANSACTION_LOGGING_ENABLED",
"allowed": ["true", "false"]
},
"disable-custom-skins": {
"env": "DISABLE_CUSTOM_SKINS",
"allowed": ["true", "false"]
},
"disable-persona": {
"env": "DISABLE_PERSONA",
"allowed": ["true", "false"]
}, },
"chat-restriction": { "chat-restriction": {
"env": "CHAT_RESTRICTION", "env": "CHAT_RESTRICTION",
@@ -146,15 +152,91 @@
"disabled": "Disabled" "disabled": "Disabled"
} }
}, },
"op-permission-level": { "disable-player-interaction": {
"env": "OP_PERMISSION_LEVEL" "env": "DISABLE_PLAYER_INTERACTION",
"allowed": ["true", "false"]
}, },
"compression-algorithm": { "client-side-chunk-generation-enabled": {
"env": "COMPRESSION_ALGORITHM", "env": "CLIENT_SIDE_CHUNK_GENERATION_ENABLED",
"allowed": ["zlib", "snappy"] "allowed": ["true", "false"]
}, },
"block-network-ids-are-hashes": { "block-network-ids-are-hashes": {
"env": "BLOCK_NETWORK_IDS_ARE_HASHES", "env": "BLOCK_NETWORK_IDS_ARE_HASHES",
"allowed": ["true", "false"] "allowed": ["true", "false"]
},
"disable-persona": {
"env": "DISABLE_PERSONA",
"allowed": ["true", "false"]
},
"disable-custom-skins": {
"env": "DISABLE_CUSTOM_SKINS",
"allowed": ["true", "false"]
},
"server-build-radius-ratio": {
"env": "SERVER_BUILD_RADIUS_RATIO"
},
"allow-outbound-script-debugging": {
"env": "ALLOW_OUTBOUND_SCRIPT_DEBUGGING",
"allowed": ["true", "false"]
},
"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"
},
"emit-server-telemetry": {
"env": "EMIT_SERVER_TELEMETRY",
"allowed": ["true", "false"]
},
"msa-gamertags-only": {
"env": "MSA_GAMERTAGS_ONLY",
"allowed": ["true", "false"]
},
"item-transaction-logging-enabled": {
"env": "ITEM_TRANSACTION_LOGGING_ENABLED",
"allowed": ["true", "false"]
} }
} }