Add SPADS install docs

documents/guides/local_setup.md

@@ -149,3 +149,6 @@ The main dependencies of the project are:
 - [Ecto](https://github.com/elixir-ecto/ecto), database ORM
 - [Ranch](https://github.com/ninenines/ranch), a tcp server
 - [Oban](https://github.com/sorentwo/oban), a backend job processing framework.
+
+### Next Steps
+If you want to develop features that interact with the lobby, then you will need to [set up SPADS](/documents/guides/spads_install.md).

documents/guides/spads_install.md

@@ -0,0 +1,103 @@
+## Purpose of SPADS installation
+If you have a local running version of TeiServer, you can point Chobby to localhost and login. However, you won't be able to see any battle rooms. To see battle rooms you will need to install SPADS.
+
+## Create a bot account to be used by SPADS
+Run TeiServer locally, login as root@localhost and go to 
+http://localhost:4000/teiserver/admin/user
+
+You should see many users here assuming you have run [Teifion's fake data script](https://github.com/beyond-all-reason/teiserver/blob/master/documents/guides/local_setup.md#fake-data).
+
+Search for a user that has FakeData as the client (i.e. a normal user). Then Edit User > Tick "Bot" and "Verified" > Save Changes
+
+The SPADS bot must have a name with **20 or less characters**. If you wish to rename the user, remove `edit` from the url, e.g.
+```
+http://localhost:4000/teiserver/admin/user/{id}
+```
+Select Actions > Rename.
+
+Note this username as it will be used later. 
+
+## Point Chobby to local TeiServer
+Inside install folder for Beyond All Reason, add a `devmode.txt` file. This will make available some dev settings in BAR.
+Open Beyond-All-Reason exe > Start > Settings > Scroll down and change Server Address to localhost
+
+Go to Multiplayer & Coop > Login as the bot user you created earlier.
+All these fake users created by Teifion's fake data script should have a password of `password`
+Accept any agreement if needed. This is just to test if everything works. You can now Exit the app.
+
+## Install SPADS Prerequisites
+Download dependencies by following the prerequisite instructions [here](https://github.com/Yaribz/SPADS/blob/master/INSTALL.md). In theory if you have TeiServer on Windows WSL, you could use either the Linux or Windows prerequisite instructions.
+
+Another dependency we need that is not listed is Inline::Python. This dependency is used by one of BAR's plugins. [Here is the install documentation.](https://github.com/Yaribz/SPADS/wiki/SPADS-Inline::Python-installation-guide)
+
+## Install SPADS
+Further down the previous page are [install instructions](https://github.com/Yaribz/SPADS/blob/master/INSTALL.md#installation-instructions) for SPADS. Follow only steps 1 and 2 of the Installation instructions. When downloading spadsInstaller.tar it might be flagged because the file is hosted on http instead of https.
+
+Now for step 3 instead run this on your SPADS folder:
+```
+perl spadsInstaller.pl --auto BarMinimalMaps
+```
+This will install SPADS with some BAR-specific configurations. It will ask some questions and most will be answered automatically. Step 8 may take a while as it downloads BAR. Near the end, it will ask you for a username/password for SPADS to use. Use the bot user you created earlier. Remember all users have password of `password`. _(If you need to change the username/password at a later point, you can edit `etc/spads.conf`)_
+
+Finally it will ask you for another login for autohost owner. You can enter anything here, even a user that doesn't exist. It's not used.
+
+## Config changes
+
+Inside your SPADS folder, open etc/spads.config and change the lobbyHost field to point to our local TeiServer
+```
+lobbyHost:127.0.0.1
+```
+
+<details>
+  <summary>If Beyond All Reason is installed in Windows and SPADS is in WSL, then open these instructions
+</summary>
+
+Change the IP address of `lobbyHost` to your WSL IP address (instead of 127.0.0.1). You can find your WSL IP address by running in command line:
+```
+wsl hostname -I
+```
+
+
+</details>
+
+
+## Install SPADS Plugins
+In your SPADS folder, open `etc/spads.conf`. Change the autoLoadPlugins line to this:
+```
+autoLoadPlugins:BarAutoUpdate;BarManager;RatingManager
+```
+Enter this exactly the same as it is case sensitive.
+
+Now we need to get BarManager and RatingManager plugins. Download the [spads_config_bar repo](https://github.com/beyond-all-reason/spads_config_bar). You can ignore the repo's readme because we only need a couple files from it.
+
+Copy from the repo these files:
+`etc/BarManager.conf`
+`etc/BarManagerCmd.conf`
+and paste into your SPADS etc folder.
+
+Copy from the repo these files:
+`var/plugins/BarManagerHelp.dat`
+`var/plugins/barmanager.py`
+`var/plugins/ratingmanager.py`
+and paste into your SPADS var/plugins folder
+
+We need to point our `var/plugins/ratingmanager.py` plugin to TeiServer so open it and set this line
+```
+server_url = "http://127.0.0.1:4000"
+```
+
+## Run SPADS
+```
+perl spads.pl etc/spads.conf
+```
+
+The first time you do this it will ask you to run it again with a parameter to trust the certificate. The [certificate](https://github.com/beyond-all-reason/teiserver/blob/master/documents/guides/local_setup.md#localhost-certs) is something you would have created when installing TeiServer.
+
+## Launch the lobby
+Run Beyond All Reason exe. Login as a user (but not the SPADS bot). You can go back to TeiServer to see the list of users. Use `password` as the password. If all is well, you should be able to see a battle room when you login to multiplayer.
+
+# Potential Errors
+### Geo IP Errors when you start a match
+You may get an error to do with geoip when you start a match. In that case, go to [localhost:4000](http://localhost:4000)
+Admin > Site Config > System
+Then change "Use geoip" to false. Restart Teiserver. Now try and start a match again and it should work.