No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
When provided a valid JSON file from the [[Command Line Arguments]]'s <code>-EngineConfig</code>, Resonite will read this file and alter itself based on the configuration parameters. | |||
== Usage == | == Usage == | ||
To use a config file you have two options. | |||
=== Using the default Config file === | |||
If a file exists in the same directory as the main Resonite executeable(Resonite.exe), that is named "Config.json", it will be used. | |||
=== Using a custom Config file === | |||
Start Resonite with the <code>-EngineConfig</code> command line argument. Following the argument enter a space and then the file path to your config file. Example: <code>-EngineConfig "C:\Cheese\cheese.json"</code> | Start Resonite with the <code>-EngineConfig</code> command line argument. Following the argument enter a space and then the file path to your config file. Example: <code>-EngineConfig "C:\Cheese\cheese.json"</code> | ||
== Configuration Properties == | == Configuration Properties == | ||
{| class="wikitable" | {| class="wikitable" | ||
! Property !! Description | ! Property !! Description | ||
| Line 21: | Line 27: | ||
|} | |} | ||
== Sample File == | == Sample File == | ||
This is a sample file: | This is a sample file: | ||
<pre> | <pre> | ||
Revision as of 02:08, 26 January 2024
When provided a valid JSON file from the Command Line Arguments's -EngineConfig, Resonite will read this file and alter itself based on the configuration parameters.
Usage
To use a config file you have two options.
Using the default Config file
If a file exists in the same directory as the main Resonite executeable(Resonite.exe), that is named "Config.json", it will be used.
Using a custom Config file
Start Resonite with the -EngineConfig command line argument. Following the argument enter a space and then the file path to your config file. Example: -EngineConfig "C:\Cheese\cheese.json"
Configuration Properties
| Property | Description |
|---|---|
| noUI | Identical to the -NoUI command line flag, hides any user space UI. |
| inputs | allows you to tweak trigger dead zones and axis dead zones |
| universeId | Specifies the UniverseId for this session |
| disableDesktop | completely disabling the Desktop functionality in Resonite |
| unsafeModeWhiteList | TODO |
| autoStartWorlds | Identical to the "startWorlds" parameter of a headless session configuration |
Sample File
This is a sample file:
{
"noUI": true,
"disableDesktop": false,
"inputs": {
"triggerDeadZone": 0,
"axisDeadZone": 0
},
"universeId": "cheese",
"unsafeModeWhiteList":["a","b"],
"autoStartWorlds": [
{
"sessionName": "The Cheese Dimension",
"customSessionId": "cheese-dimension",
"description": "Cheese for all!",
"maxUsers": 32,
"accessLevel": "Anyone",
"hideFromPublicListing": false,
"tags": ["cheese", "dimension"],
"mobileFriendly": false,
"loadWorldUrl": "resrec:///U-Cheese/R-c59ca2b2-2239-492d-98ee-b37cefbb6ba7",
"loadWorldPresetName": "GridSpace",
"forcePort": 4020,
"keepOriginalRoles": true,
"defaultUserRoles": {
"CheeseLord": "Admin"
},
"awayKickMinutes": 5
}
]
}