• Established in 2018
  • Developed in the UK
  • Over 9000 Users Worldwide
  • 194 Million Patches Delivered

LaunchBoost.io

Login
Plans
Priority SupportVIP
Skip the queue on Discord
/Documentation/Developer Dashboard/Patch Settings

Patch Settings

Patchlist Filename

This is the name of the patchlist JSON manifest file that holds all the information for your game patches. By default this is patchlist.json

Ideally, you should just leave this as patchlist.json

Plain Text
patchlist.json
Patch Salt

The Patch Salt is a ‘secret key’ which is integrated into your final checksum for file integrity checks.

You can generate any password here. Keep it safe and secure.

You should ideally use a patch salt that is random letters and numbers, between 6 – 20 characters long.
Allow player to choose server in the client

If this is checked, and you have more than one server defined in your server array, then a dialog will prompt the user to ask them to choose which server should be their primary server.

This is useful for if you have multiple patch servers/mirrors in different countries. You can then allow the user to select the closest country to them for faster downloads. For example, one server in the UK and one in the US.

This can be bypassed if you want to create your own “server selection” dialog or routine in your game or application. You can simply send a command line to the patch system to define which server to use as the primary server. Server index numbers can be found on the server page in your server list.

You would send it as a command line argument like this:

Plain Text
patch.exe -apiKey= -project_slug= -server=1
Cachebuster Type

default – This appends a cachebuster query to your server files. This ensures every single file is brand new and fresh everytime and never served from cache. We don’t recommend this unless you have a good server and hardware.

none – If you are using serverside file caching, use none in the box to ensure cachebuster queries aren’t appended.

version – Same as default, however the version number is appended on the cachebusting string. This enables for better log viewing on your server. Still not recommended unless you have a really good server with a lot of bandwidth.

We always encourage server-level caching. This increases performance for downloads but also inflicts less stress on your servers.

From wherever you host your files (Web Hosting, VPS, Dedicated Server, CloudFlare), you must ensure you enable serverside caching where possible.

For example, for web hosting, vps and dedicated servers, you should enable and use nginx on top of, or opposed to Apache. Nginx allows fast caching of files that are frequently accessed. Varnish may also help. For other services, they may have even better caching. You will need to consult with your web host provider on this.

If you are using one of our Patch Servers, you don’t need to worry as they are already super-optimized for you – Click Here to View
If you do enable file caching, you must ensure you optimize dependant on how many updates you push out. For example, if you push out more than one update a week, then it’s best to ensure files are only cached for a short period like a few hours. If you only push out updates every month or longer, then stipulate a longer cache expiry.

Either way, once you have pushed out a new update, you must ensure you clear your caches to ensure your users get the latest and new versions of your files.

Custom File Extension

Both servers and antivirus/firewall software can be funny when it comes to hosting and downloading files with extensions like .exe, .dll etc.

So we highly recommend you use a custom file extension here. This will not break any of your game files. It is purely used to just rename the files to host on your server and once downloaded, the extension is stripped.

The default is PATCH. You can use anything here, just don’t put the dot .

LBP is the default if you don’t specify, but we still recommend you use PATCH as the default.

Plain Text
PATCH
PreviousProjectsNext Splash Screen