Configuration

Here is an example of the config file:

{
  "NotWhitelistedText": "User \"%username\" is not whitelisted on this instance",
  "ExternalURL": "auto:10050",
  "MysqlConnectionString": "server=127.0.0.1;uid=root;pwd=password;database=PLGarage",
  "Whitelist": false,
  "BlockMNRPS3": false,
  "BlockMNRPSP": false,
  "BlockMNRRT": false,
  "BlockLBPK": false,
  "InstanceName": "PLGarage",
  "ServerCommunicationKey": ""
}

Please note that any changes to the config file only apply on the next restart

NotWhitelistedText

This variable defines the text displayed as Eula when you have whitelist turned on, but the user who's trying to connect is not whitelisted.

ExternalURL

The external url that the game will use to download user content, it is required for your server to function properly, but you can leave it at it's default value auto:10050 where auto means that the server should deternine the protocol and domain automatically depending on the request while :10050 is the port that the server is accessible from. It is not recommended to change the port because it might cause CDN related issues in game.

MysqlConnectionString

PLGarage uses Pomelo.EntityFrameworkCore.MySql as a database provider for Entity Framework which uses MySqlConnector underneath and if you want to learn more about connection string options click here

Whitelist

A boolean value that defines if the users should be whitelisted before connecting to the server. If set to true the program will create a file called whitelist.json on the next connection attempt. To whitelist a user simply add their name to the list.

BlockMNRPS3

Set to true if you want to prevent ModNation Racers (PS3) players from joining your server.

BlockMNRPSP

Set to true if you want to prevent ModNation Racers (PSP) players from joining your server.

BlockMNRRT

Set to true if you want to prevent ModNation Racers: Road Trip players from joining your server.

BlockLBPK

Set to true if you want to prevent LittleBigPlanet Karting players from joining your server.

InstanceName

This is the name of your instance that the other "modules" could display(for example a website)

ServerCommunicationKey

The key used to encrypt communication between the server connected to your PLGarage instance