Skip to content

Changes

Page history
Update Installing OverlordBot authored by Jeffrey Jones's avatar Jeffrey Jones
Show whitespace changes
Inline Side-by-side
Installing-OverlordBot.md
View page @ 86bbd203
...@@ -12,17 +12,17 @@ OverlordBot requires a windows host to run the SRS bot client, it is recommended ...@@ -12,17 +12,17 @@ OverlordBot requires a windows host to run the SRS bot client, it is recommended
This instruction page will assume you are installing everything on the same Windows host. This instruction page will assume you are installing everything on the same Windows host.
Note: It *might* be possible to run the bot on Linux but I have never tested this so you will need to be in a pioneering spirit if you want to try. Note: It _might_ be possible to run the bot on Linux but I have never tested this so you will need to be in a pioneering spirit if you want to try.
## Install dependencies ## Install dependencies
### Visual C++ Redistributable ### Visual C++ Redistributable
https://aka.ms/vs/16/release/vc_redist.x64.exe [https://aka.ms/vs/16/release/vc_redist.x64.exe](https://aka.ms/vs/16/release/vc_redist.x64.exe)
### Java JDK ### Java JDK
Download the 64-bit Windows zip file for 11.0.2 from https://jdk.java.net/archive/ and unzip the jdk folder into a suitable location. We recommend `C:\Program Files` so that the full path is `C:\Program Files\jdk-11.0.2`. Download the 64-bit Windows zip file for 11.0.2 from [https://jdk.java.net/archive/](https://jdk.java.net/archive/) and unzip the jdk folder into a suitable location. We recommend `C:\Program Files` so that the full path is `C:\Program Files\jdk-11.0.2`.
Then create a System Environment Variable called `JAVA_HOME` and set the value to the location where you copied the JDK to (e.g. `C:\Program Files\jdk-11.0.2`) Then create a System Environment Variable called `JAVA_HOME` and set the value to the location where you copied the JDK to (e.g. `C:\Program Files\jdk-11.0.2`)
...@@ -30,43 +30,42 @@ Note: At the time of writing the latest version of the JDK is JDK 14 but this ca ...@@ -30,43 +30,42 @@ Note: At the time of writing the latest version of the JDK is JDK 14 but this ca
### JRuby ### JRuby
Note: Do this *after* you have installed the JDK as detailed above. Note: Do this _after_ you have installed the JDK as detailed above.
Download the latest version of JRuby from https://www.jruby.org/ exe(x64) and run the installer to install JRuby. Download the latest version of JRuby from [https://www.jruby.org/](https://www.jruby.org/) exe(x64) and run the installer to install JRuby.
### PostgreSQL ### PostgreSQL
Download and install the latest version of PostgreSQL from https://www.enterprisedb.com/downloads/postgres-postgresql-downloads . Remember to make a note of the superuser password you create. Download and install the latest version of PostgreSQL from [https://www.enterprisedb.com/downloads/postgres-postgresql-downloads](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads) . Remember to make a note of the superuser password you create.
### PostGIS ### PostGIS
Note: Do this *after* you have installed PostgreSQL as detailed above. Note: Do this _after_ you have installed PostgreSQL as detailed above.
There are two options for installing PostGIS There are two options for installing PostGIS
1. Use the PostgreSQL Stackbuilder tool to install PostGIS (under "Spatial Extensions") 1. Use the PostgreSQL Stackbuilder tool to install PostGIS (under "Spatial Extensions")
2. Download and Install the latest released version of PostGIS for your version of PostgreSQL from http://download.osgeo.org/postgis/windows/ 2. Download and Install the latest released version of PostGIS for your version of PostgreSQL from [http://download.osgeo.org/postgis/windows/](http://download.osgeo.org/postgis/windows/)
## .Net Framework 5.0 ## .Net Framework 5.0
Download and install the x64 .Net Frameworok 5.0 or later runtime from later https://dotnet.microsoft.com/download/dotnet/current/runtime Download and install the x64 .Net Frameworok 5.0 or later runtime from later [https://dotnet.microsoft.com/download/dotnet/current/runtime](https://dotnet.microsoft.com/download/dotnet/current/runtime)
# Azure Setup # Azure Setup
## Rename your directory ## Rename your directory
Rename your directory from "Default Directory" to something descriptive that will make you unique amont other OverlordBot users by following the instructions on the following site: https://ppolyzos.com/2020/06/11/rename-your-azure-default-directory-name-to-something-comprehensible/ Rename your directory from "Default Directory" to something descriptive that will make you unique amont other OverlordBot users by following the instructions on the following site: [https://ppolyzos.com/2020/06/11/rename-your-azure-default-directory-name-to-something-comprehensible/](https://ppolyzos.com/2020/06/11/rename-your-azure-default-directory-name-to-something-comprehensible/)
## Create Resources ## Create Resources
1. Create a Microsoft Azure account at https://azure.microsoft.com . This will require a valid credit card even though the bot will only use the free tier. 1. Create a Microsoft Azure account at [https://azure.microsoft.com](https://azure.microsoft.com) . This will require a valid credit card even though the bot will only use the free tier.
2. Create the following two resources in the region nearest to where your DCS server is located and choose the free pricing tier. 2. Create the following two resources in the region nearest to where your DCS server is located and choose the free pricing tier.
It is recommended to use `YOUR-DIRECTORY-NAME-OverlordBot-Speech` and `YOUR-DIRECTORY-NAME-OverlordBot-LUIS` as the resource names. It is recommended to use `YOUR-DIRECTORY-NAME-OverlordBot-Speech` and `YOUR-DIRECTORY-NAME-OverlordBot-LUIS` as the resource names.
* ![Speech](https://catalogartifact.azureedge.net/publicartifacts/Microsoft.CognitiveServicesSpeechServices-1.0.23/Small.png) Speech * ![Speech](https://user-content.gitlab-static.net/94f84c725e2fb35ee08e1816aa3c900aac291cb1/68747470733a2f2f636174616c6f6761727469666163742e617a757265656467652e6e65742f7075626c69636172746966616374732f4d6963726f736f66742e436f676e6974697665536572766963657353706565636853657276696365732d312e302e32332f536d616c6c2e706e67) Speech
* ![LUIS](https://catalogartifact.azureedge.net/publicartifacts/Microsoft.CognitiveServicesLUISAllInOne-1.0.114/Small.png) Language Understanding * ![LUIS](https://user-content.gitlab-static.net/5cca9fb57634df12ca74a83120dee0539caa2756/68747470733a2f2f636174616c6f6761727469666163742e617a757265656467652e6e65742f7075626c69636172746966616374732f4d6963726f736f66742e436f676e697469766553657276696365734c554953416c6c496e4f6e652d312e302e3131342f536d616c6c2e706e67) Language Understanding
## Resource Setup ## Resource Setup
...@@ -86,19 +85,21 @@ Contact `DOLT 1-2 | RurouniJones` for information on what email to use to grant ...@@ -86,19 +85,21 @@ Contact `DOLT 1-2 | RurouniJones` for information on what email to use to grant
Unfortunately due to some oversights in the latest Luis UI. Microsoft does not support initial onboarding of LUIS applications to LUIS resources not owned by the LUIS application owner (i.e. the OverlordBot developer). Unfortunately due to some oversights in the latest Luis UI. Microsoft does not support initial onboarding of LUIS applications to LUIS resources not owned by the LUIS application owner (i.e. the OverlordBot developer).
Follow the instructions in section **"Assign a query prediction runtime resource without using the LUIS portal"** (Skip step 2) at https://github.com/MicrosoftDocs/azure-docs/blob/b460ff65753190c7e93f604d0d56b4dc419dfa20/articles/cognitive-services/LUIS/luis-how-to-azure-subscription.md#assign-a-query-prediction-runtime-resource-without-using-the-luis-portal Before following the instructions below you will need the following information:
Note that the Microsoft docs could be better. Make sure you are calling the correct API for associating the application. See the below screenshot that shows the API you want to be using
![application-association](uploads/d0b4edfeada6bec154f9faff7ef74ebf/application-association.png) * The `Ocp-Apim-Subscription-Key` field requires a key that you need to ask the OverlordBot developer for when you are ready.
* The `appId` field changes depending on where your resources are located.
* Not Europe or Australia: `2414f770-d586-4707-8e0b-93ce0738c5bf`
* Europe: `f4794423-17dc-47af-b18b-6c9b6cf3daac`
* Australia: `08965479-f20b-439a-9b8d-6cc6601386cb`
The `Ocp-Apim-Subscription-Key` field requires a key that you need to ask the OverlordBot developer for when you are ready. See [https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions) for a mapping if you are not sure which region your resources are locate in.\
\
Follow the instructions in section **"Assign a query prediction runtime resource without using the LUIS portal"** (Skip step 2) at [https://github.com/MicrosoftDocs/azure-docs/blob/b460ff65753190c7e93f604d0d56b4dc419dfa20/articles/cognitive-services/LUIS/luis-how-to-azure-subscription.md#assign-a-query-prediction-runtime-resource-without-using-the-luis-portal](https://github.com/MicrosoftDocs/azure-docs/blob/b460ff65753190c7e93f604d0d56b4dc419dfa20/articles/cognitive-services/LUIS/luis-how-to-azure-subscription.md#assign-a-query-prediction-runtime-resource-without-using-the-luis-portal)
The `appId` field changed depending on where your resources are located. See https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions for a mapping (it is not always obvious!). Note that the Microsoft docs could be better. Make sure you are calling the correct API for associating the application. See the below screenshot that shows the API you want to be using
* (www.luis.ai) Not Europe or Australia: `2414f770-d586-4707-8e0b-93ce0738c5bf` ![application-association](/overlord-bot/srs-bot/-/wikis/uploads/d0b4edfeada6bec154f9faff7ef74ebf/application-association.png)
* (eu.luis.ai) Europe: `f4794423-17dc-47af-b18b-6c9b6cf3daac`
* (au.luis.ai) Australia: `08965479-f20b-439a-9b8d-6cc6601386cb`
### Get the Speech endpoint ID ### Get the Speech endpoint ID
...@@ -161,29 +162,29 @@ ALTER TABLE public.units ...@@ -161,29 +162,29 @@ ALTER TABLE public.units
Install TacSCribe by running the following commands in windows command line: Install TacSCribe by running the following commands in windows command line:
``` ```plaintext
gem install bundler gem install bundler
gem install tac_scribe gem install tac_scribe
``` ```
It is then recommended to create a `.bat` file to run the full command (Replacing the variables with your needed values). It is then recommended to create a `.bat` file to run the full command (Replacing the variables with your needed values).
```plain ```plaintext
Title SERVER NAME Title SERVER NAME
mode con:cols=135 lines=15 mode con:cols=135 lines=15
powershell -Command "tac_scribe -h SERVER -a PASSWORD -u overlordbot -s overlordbot -n DATABASE_NAME -v -w 'C:\PATH\TO\whitelist.txt' | Tee-Object -FilePath 'C:\PATH\TO\LOGS\SERVER_NAME_tac_scribe.log'" powershell -Command "tac_scribe -h SERVER -a PASSWORD -u overlordbot -s overlordbot -n DATABASE_NAME -v -w 'C:\PATH\TO\whitelist.txt' | Tee-Object -FilePath 'C:\PATH\TO\LOGS\SERVER_NAME_tac_scribe.log'"
``` ```
For all the options and what they do run `tac_scribe --help` in a windows command prompt. For an example, recommended, whitelist see https://gitlab.com/overlord-bot/tac-scribe/-/blob/master/data/whitelist.example For all the options and what they do run `tac_scribe --help` in a windows command prompt. For an example, recommended, whitelist see [https://gitlab.com/overlord-bot/tac-scribe/-/blob/master/data/whitelist.example](https://gitlab.com/overlord-bot/tac-scribe/-/blob/master/data/whitelist.example)
## Commander-In-Chief ## Commander-In-Chief
Commander-in-Chief (CinC) is a DCS RPC server that allows clients to call predefined commands in the DCS lua environment. It is currently used by OverlordBot to retrieve Airfield information to determine weather conditions and ownership. Commander-in-Chief (CinC) is a DCS RPC server that allows clients to call predefined commands in the DCS lua environment. It is currently used by OverlordBot to retrieve Airfield information to determine weather conditions and ownership.
Follow the instructions @ https://gitlab.com/cinc/pure-lua/cinc-server/-/releases Follow the instructions @ [https://gitlab.com/cinc/pure-lua/cinc-server/-/releases](https://gitlab.com/cinc/pure-lua/cinc-server/-/releases)
## OverlordBot ## OverlordBot
Install the latest version of the bot from https://gitlab.com/overlord-bot/srs-bot/-/releases Install the latest version of the bot from [https://gitlab.com/overlord-bot/srs-bot/-/releases](https://gitlab.com/overlord-bot/srs-bot/-/releases)
Extract the `zip` to the folder of your choice, copy the `configuration.yaml` from the `Documentation` folder into the main folder wtih the exe. Once you have filled in your `configuration.yaml` run `OverlordBot-Console.exe` to start the bot. Extract the `zip` to the folder of your choice, copy the `configuration.yaml` from the `Documentation` folder into the main folder wtih the exe. Once you have filled in your `configuration.yaml` run `OverlordBot-Console.exe` to start the bot.
\ No newline at end of file