-
-
Notifications
You must be signed in to change notification settings - Fork 241
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Feature: Creating a default Variables JSON from environment variables #469
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -109,6 +109,7 @@ Typically, each property is configured instead by the UPPER_SNAKE_CASE equivalen | |
- `EMIT_SERVER_TELEMETRY` | ||
- `MSA_GAMERTAGS_ONLY` | ||
- `ITEM_TRANSACTION_LOGGING_ENABLED` | ||
- `VARIABLES` | ||
|
||
For example, to configure a flat, creative server instead of the default use: | ||
|
||
|
@@ -191,6 +192,24 @@ There are various tools to look XUIDs up online and they are also printed to the | |
-e ALLOW_LIST_USERS="player1:1234567890,player2:0987654321" | ||
``` | ||
|
||
## Variables | ||
|
||
Custom server variables are passed in just like the allowlist or as a full JSON string. | ||
|
||
Server variables are parsed into their most likely type (number-like turn into numbers, all other inputs are treated as string) using jq's `fromjson` command. In the example below, `var1` is a string, `var2` is a number, and `var3` is a string. | ||
|
||
For greater control on types, users can provide a full string JSON representation that is used as-is. | ||
|
||
All variables are written to the config/default/variables.json. There is no support for Module-specific variable handling at this time. | ||
|
||
```shell | ||
# passing in simple expressions | ||
-e VARIABLES="var1:customStringValue,var2:1234,var3:true" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It seems like in non-json form it would be more intuitive to use equal signs such as var1=value,var2=value There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to diverge from the format for the allowlist variable? I only kept using colons to follow the previous input formatting. not an issue to change if we're okay with different formats for different env var inputs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think that's ok since your scenario is a definitive name=value whereas the allowlist is a pairing of values due to the XUID weirdness. |
||
|
||
# pass in a full json object: | ||
-e VARIABLES='{"mobSpawnRate":22,"enableCheats":true,"worldArray":["My World", "Abc", 123]}' | ||
``` | ||
|
||
## Mods Addons | ||
|
||
Also known as behavior or resource packs, in order to add mods into your server you can follow these steps, tested with [OPS (One Player Sleep)](https://foxynotail.com/addons/ops/) and [bedrocktweaks](https://bedrocktweaks.net/resource-packs/) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be good to somehow include here the link to the Microsoft docs you mentioned in your reply.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can do.