LauncherConfig.ini In depth explanation

In this article, we'll go over each key in the Launcher's config.

The default configuration

[Launcher]
ChangelogAddress=http://www.example.com/launchpad/changelog/changelog.html
SystemTarget=Linux

[Game]
Name=LaunchpadExample
ExecutablePath=LaunchpadExample/Binaries/Linux/LaunchpadExample

[Remote]
Address=ftp://ftp.example.com/
Username=anonymous
Password=anonymous
FileDownloadRetries=2
FileDownloadBufferSize=8192

In the launcher config, we have three primary sections. Each one of these contains one or more options which are used by the launcher to talk to the file server, query for updates and report back home.

Launcher

SystemTarget (ESystemTarget)

The platform the launcher will download the game for. This value is an enum, and determines what operating system the launcher is downloading for.

This value can be one of the following:

• Linux
• Mac
• Win32
• Win64

If it is not, problems will occur and the launcher will be sad. Don't let the launcher be sad :(

ChangelogAddress (string)

The URL the launcher will fetch its changelog from.

Game

Name (String)

The name of the installed game. This value is used to find the executable (which is assumed to be named the same as the game), and is also displayed in the window title of the launcher.

ExecutablePath (Path)

The relative path to your game's executable file. This path is rooted in the game directory.

Remote

Address (URL)

The URL pointing to the base directory of the launcher on your patching server. For the HTTP protocol, this should be prefixed with http://. For the FTP protocol, this should be prefixed with ftp://.

Username (String)

The username which is used to authenticate with the patching server. You can usually leave this as anonymous, as having a login is largely redundant. Still, it can be used to employ actual logins to the server, should that be of interest.

Password (String)

The password for the username specified above. You can usually leave this as anonymous for the same reasons as above.

FileDownloadBufferSize (UInt32)

The size of the download buffer. Tweaking this value can improve download speeds depending on the bandwidth of your server.

FileDownloadRetries (UInt32)

The number of times to retry downloading a failed file. Failure to download a file can be caused by intermittent internet connection, and this setting allows for a little bit of extra safety. You should probably not go over 2 or 3 here.