External Configuration
It is possible to set up a website to act as external configuration repository for your Batclient folder. This makes Batclient
download a zip file and unzip it in the user.home directory overwriting all existing Batclient files when it is started. It is only possible to
load files this way. Saving is only done locally on the computer so any changes made while playing will not affect your
external configuration zip file. For security you can add a login and password on your site so others cannot reach your files.
|
WARNING! If you zip your whole batclient folder you will include the config.xml file that includes your
password (in encrypted state). If you do not secure your website this means anyone can use a webbrowser to
read your password. You may also wish to turn off saving password before closing Batclient and zipping the
batclient folder so it is not saved in the config.xml file. Also beware that all your scripts, triggers and
plugins will be available on the website if you zip everything in the batclient folder.
|
Setup instructions
- 1) Start and setup your client to the state you wish to save to your site. Then close Batclient.
- 2) Goto your user.home directory. It should contain a "batclient" folder. Zip this folder to "batclient.zip". The
contents of the zip file should be a folder named "batclient/" which contains the full directory structure and all files.
- 3) Upload the batclient.zip file to your site. (For example https://mysite.com/batclient/batclient.zip).
- 4) Create a file called "external_config.xml" in your user.home/batclient/conf directory. (Along the other conf files such as keybinding.xml).
- 5) Edit the external_config.xml file with the correct user, password and url to the zip file. An example file can be found at: https://www.bat.org/batclient/external_config.xml
- 6) Secure your website!. You may wish to put a .htpasswd file in your folder on the website to secure it and add a login so others cannot reach
your files. This .htpasswd should be setup to use the same user and password that you specified in the external_config.xml file. For more information
about how to secure a website and add logins using .htpasswd use google!
Note that you will need to have the external_config.xml file in your user.home/batclient/conf folder for batclient to download and extract the
zip file when it is started. If you wish to turn off the external config files simply delete this file.
Example external_config.xml file
To see an example of an external config file visit: https://www.bat.org/batclient/external_config.xml