Development utilities for the PR:BF2 server.

Server development

You may use this repo in parallel with the server repository to host a development server.

> ./scripts/serve.sh path-to-server-folder

This runs the PR server in a docker container By default the server listens for connections on 192.168.200.2:16567, and it should be visible in the local servers list. Make sure you use an online account to connect. Local accounts incorrectly give an error about the server version not matching your game version.

Using Visual Studio Code

You can set up a workspace file similar to the one below, to have both baker and the server files available simoultaneously:

{
	"folders": [
		{
			"name": "baker",
			"path": "path/to/baker",
		},
		{
			"name": "server",
			"path": "path/to/server",
		},
	],
	"settings": {
		"python.pythonPath": "path/to/your/local/python2.7.16",
        // Plyance doesn't support Python 2
		"python.languageServer": "Jedi",
		"python.linting.enabled": true,
        // Allow search in ignored files
		"search.useIgnoreFiles": false,
        // Hide executables and precompileds from the explorer to reduce clutter
		"files.exclude": {
            "**/*.zip": true,
			"**/*.dll": true,
			"**/*.exe": true,
			"**/*.pyc": true,
			"**/*.pyd": true,
			"**/*.pyo": true
		},
	}
}

Baking a new version

Setting up to run prserverupdater

To create a baked server version, you will need the base server zip provided by the developers. You can download the server license zip from the licence control panel on realitymod.com.

I recommend that you place this file into the baker folder, but you can put it anywhere you want.

Next, prserverupdater requires a license.key file to work with when updating the server. If you happen to have an already running server you can just copy this from the server folder. Otherwise, you will have to create it in the root directory of the poject. You can find your key on the server license control panel.

# Create the license file, and edit it to contain the license key.
> touch ./license.key
> vim license.key
# ... edit license.key to contain the key

Baking a server version

Once everything is set up, you can then run the bake command, which will unzip the server into a temporary folder, run prserverupdater to get the latest server version and finally strip out any unnecessary files.

# Running the bake command
# Use your server IP and port associated with the license.
> ./scripts/bake.sh prbf2_1.6.3.0_server.zip 0.0.0.0 16567

The IP and port doesn't have to be real or point to a valid server, it just has to match the ip on the license page.

If you provide no port, the baker usees the default BF2 port 16567.

The resulting server files will reside in bakes/<starting_zip_name>_baked. Normally this folder is then copied to replace the server folder of the server repository, and committed as a new base version.

Cleaning up bakes

If you no longer need the baked files, or you want to clean up after a failed bake, run ./baking/clean.

# Deleting all bakes and generated files
> ./scripts/clean.sh