Configuration

Patchwork is configured via a toml configuration file located at /dev_hdd0/plugins/patchwork/patchwork.toml

Example config

This is a full example config for Patchwork 2.0, the values will be explained in the next section.

[patchwork]
server_url = "http://lbp.lbpbonsai.com/lbp"
digest_key = "CustomServerDigest"
join_key = "password123"
enable_join_key = true

[updates]
enable_updates = true
update_server = "https://patchwork-updates.hugespaceship.io/prx-update"

Configuration values

patchwork Section

These values are for configuring the game patches.

server_url

This is the server to patch the game to connect to, you’re most likely to have luck with HTTP as HTTPS tends to have issues with how much root certificates have changed in the last 15 years. It must be formatted as the full URL to the server, and the base path for the game API. If left blank the server URL will not be patched.

Example: "http://lbp.lbpbonsai.com/lbp"

digest_key

This is the key used to form the X-Digest-A and X-Digest-B headers that the game/server use to disuade request forgery. It is an 18 byte string that can be anything, however it should be set to the digest of your server, if it has a custom one.

Example: "CustomServerDigest"

join_key

The join key is a value used to derive a custom XXTea key for multiplayer packets, this is used as a rudimentary way of stopping random players from joining you, as if the key doesn’t match then multiplayer will not work. Its behaviour is controlled by the enable_join_key boolean, if join keys are enabled a blank value will cause a random key to be generated, and a set value will be hashed to make the key.

It can be any string, however strings longer than 16 characters will be truncated.

Example: "password123"

enable_join_key

This boolean controls whether the join key is used, if it’s set to true then the XXTea multiplayer key will be changed, either to a random value or a hash of the join_key; otherwise it will be left alone.

Valid values are either true or false

updates section

These values are used for configuring auto-updates. More information about auto-updates can be found in the auto-updates documentation.

enable_updates

This boolean configures whether to check for updates on boot or not, if an update is found then it will be downloaded and the PRX module reloaded, otherwise it will boot as normal.

Valid values are either true or false

update_server

This string is the URL to check for updates at, it should be a full URL to the server. HTTPS is not supported yet.

Example: https://patchwork-updates.hugespaceship.io/prx-update