The remote client exist to help users without a FullClient on their computer to play by downloading resources from an external server. Because pushing directly the fullclient on a server/ftp can provoke some errors, this tool allow to :

• Get the files from a client used in another domain (Cross-origin resource sharing).
• Extracting files directly from GRF archive (only version 0x200 supported for now - without DES encryption).
• Converting BMP files to PNG to speed up the transfer.
• Optimized to don't call any script if files are already extracted/converted (resource friendly).

###Add your fullclient###

Just put your GRFs files and DATA.INI file in the resources/ directory. Overwrite the BGM/, data/ and System/ directories with your own folders.

Note: to be sure to use a compatible version of your GRFs, download GRF Builder and repack them manually (Option > Repack type > Decrypt -> Repack), it will ensure the GRFs files are converted in the proper version

You can use this setup with the container to run the remote client API. Using docker container does not handle/copy the game files. You need to set up them first on the directory.

Copy the file .env.example to the same directory as .env

After copying the game files and modifiying your .env file, you can start the container services.

You can start using the remote client with NGINX using the following command:

docker compose --profile nginx up --build

The webserver will be answering requests on the 80 port.

docker compose --profile apache up --build

The vhosts configuration for both Apache and NGINX are baked into the container recipe. If you need to change this, you have to modify the respective Apache Dockerfile or NGINX dockerfile and re-run the docker compose command.

You can also override vhost configuration on /etc/apache2/sites-available/000-default.conf for Apache or /etc/nginx/conf.d/default.conf for NGINX using docker compose specification adding a bind mount, example:

volumes:
  - ./:/var/www/html:ro
  - ./my-own-nginx.conf:/etc/nginx/conf.d/default.conf

If you set up all the required files correctly, you can run the python script tester.py. This script reads a file list in the same directory (list.txt) that contains multiple filenames that should be in a GRF. The script will request each file to the target webserver defined in TARGET_SERVER_ADDRESS variable, checking if the server answers with an HTTP code 200, if not, a new log file is created with the HTTP code and the file url requested, so you can debug it afterward.

Example, running the list against a working server (localhost, apache and nginx):

Apache

=== Final result ===
Total: 2784 | OK: 2784 | FAIL: 0
Elapsed time: 110.10 seconds

NGINX

=== Final result ===
Total: 2784 | OK: 2784 | FAIL: 0
Elapsed time: 1.86 seconds