Startup config

This article or section is a stub. You can help the Resonite wiki by expanding it.

When Resonite launches, it reads from a special configuration file that can be used for advanced features and settings. The format of the file is JSON.

Location

By default, the location of the configuration file is in the Resonite installation directory and named `Config.json`.

Alternatively, the -EngineConfig command line argument can be used to specify a custom path to the config file.

Available properties

Root
Property	Type	Description
disableDesktop	bool	When true, entirely disables the Desktop viewing/interaction functionality.
noUI	bool	When true, hide all userspace UI. Identical to the -NoUI command line flag.
disableIntroTutorial	bool	When true, forcibly disables the tutorial.
disableCloudAutoHomeLoad	bool	When true, disables loading the cloud home on startup.
noUI	bool	When true, hide all userspace UI. Identical to the -NoUI command line flag.
inputs	InputConfig	Allows tweaking of joystick and trigger deadzones.
unsafeModeWhiteList	List<string>	World URLs that can be opened with the -OpenUnsafe command line argument.
pathWhitelist	List<string>	A list of paths that the file browser can access. Can be set to an empty array ([]) to disable file browser functionality.
autoStartWorlds	List<WorldStartupParameters>	Sessions to host when the engine launches. Identical to the startWorlds parameter of a headless session configuration.
autoJoinSessions	List<SessionJoinParameters>	Sessions to attempt joining when the engine launches.
lnlConfig	LNLConfig	Configuration options for LNL.
proxy	ProxyConfig	Specifies a proxy server for Resonite to use. See proxy support for full details.
universeId	string	Specify the universe ID of the engine.

InputConfig
Property	Type	Description
triggerDeadZone	float	Deadzone of trigger pressure
axisDeadZone	float	Deadzone along controller axes

LNL Config

The lnlConfig item allows you to specify additional configuration options that specifically affect LNL.

Ports

Currently there is only one property ports. Ports allows you to specify the minimum and maximum port number that can be used by LNL.

For example:

...
"ports": {
    "min": 3000,
    "max": 3100
},
...

Would restrict LNL to use ports from 3000 to 3100. Both Minimum and Maximum are 'inclusive, which means that in the above example the first port to be allocated to an LNL connection would be 3001 and the last port allocated would be 3100.

If Resonite gets to the end of the available port range, it will also try the default behaviour(if this option was not defined) which is to allow the operating system to select a port itself. This is a last resort designed to allow a session to continue to proceed even if it might not be able to be connected to by another user.

We recommend that the number of ports covered by your range is at least 10, just in-case.

However, to aid you in determining a suitable number of ports for the range, keep in mind the following:

1. Each session you host consumes a Port.
   • So if you load the Local and Cloud Home, you have already used 2.
   • The Local home is included because it is possible to open this world up to other users
2. Each session you join consumes a Port.

So in the event that you open Resonite with default settings to join a friend then you'd need a total of 3 ports in the range. Then add 1 to the length of this range for every additional session you wish to join.

Closing a session, will free up the port that was used.

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
    }
  ]
}

See Also

• Headless_Client/Configuration_File