bot

README

Real Weather Bot

About

Real Weather Bot is a Discord companion bot for DCS Real Weather. The bot provides an interface to get and set data from the Real Weather utility.

Setup

To setup the Real Weather Bot, you'll first need to create a new Discord application through the Discord developer hub. Click the "New Application" button found at the top right of the portal.

Give the application a name such as "Real Weather Bot". You'll then have to agree to the developer TOS and developer policy. Click continue once you are ready.

Once the new application is created, you should be taken to the page to configure the bot. Here you can add a description to the bot, or click on the app icon button to add a picture for your Real Weather Bot.

If you would like to use the official Real Weather icon for your bot, you can find it here.

Once you have personalized the bot to your liking, click on the "OAuth2" tab on the left hand side bar. In the OAuth2 URL Generator, select the "bot" scope, and then add "Send Messages" to the text permissions. It should look like this:

Then paste the generated URL into your browser and follow the steps to invite it to your server.

[!WARNING] Before continuing, it is highly recommended that you turn off the "public bot" toggle under the bot tab in the developer portal. This will prevent others from inviting your instance of Real Weather Bot to their server.

Real Weather Bot should now be in your server! Keep reading to see how to run and use the bot.

Usage

Download the latest bot release. Open the botconfig.json in a text editor of choice.

You'll first need to get your GuildID for the server you invited the bot to. You can do this enabling Discord developer mode, right clicking on your server, and then pressing "Copy Server ID." Paste this between the quotes after "guild-id": in the config.

Then get your bot token from the developer portal. Click on the "Bot" page from the left side, and find the token section. If you've already requested a token and forgotten it, you'll have to reset it. Otherwise, show the token and save it into the "bot-token" parameter in the config. You will only be able to show your token once.

You will also need to give your Real Weather Bot a place to put its log file with the "log" parameter. This can take an absolute or relative path.

[!NOTE] You can use backslashes \ in your paths, but if you do you will have to escape them with another backslash, so C:\Users\myuser would look like C:\\Users\\myuser. You can also use forward slashes / instead without having to escape them.

Real Weather Bot also needs to know some basic info about each server instance you would like the bot to interface with. The "instances" parameter of the config is an array where each array item describes one server. The parameters you will need to setup are "name", "real-weather-path", and "real-weather-log-path".

The "name" parameter serves as both a friendly reminder to you which server the section is for, and also as a way to tell the bot which server you want a given command to target. When multiple instances are in use, the bot will require you to provide a server parameter with each command that will take the names as an option.

You will also need to give your Real Weather Bot a place to put its log file with the "log" parameter. This can also take an absolute or relative path.

Each instance must also specify the path of your Real Weather executable with the "real-weather-path" parameter, and the path to your real weather log file with the "real-weather-log-path" parameter. Both of these can take absolute (e.g. C:/Users/myuser/Desktop/realweather/realweather.exe) or relative paths (e.g. ../realweather/realweather.exe).

[!IMPORTANT] With the current multi-instance implementation, each server specified in "instances" should have unique paths to Real Weather and its log. Not abiding this may result in bot commands affecting the wrong server.

Now that everything is configured, you should be able to run the bot and see it come online in your discord server. If anything was configured wrong, the bot log should show you what happened.

Commands

The currently supported bot commands are given below:

• /set-weather
  • Allows the user to override weather for the next Real Weather run cycle. this command requires you to have the "use-custom-data" parameter in your Real Weather config set to true. In order for users to run this command, they also must have a role called "Real Weather" assigned to them. Any weather not overriden with this command will be fetched from CheckWx like normal.
• /last-metar
  • Fetches and shows the latest METAR from your Real Weather log file.