OnAir Discord Bot

A Discord.js bot that integrates Your OnAir Company or Virtual Airline's details within your Discord server. Giving your users the ability to query flights, members, jobs, fleet, and airport information from within discord, each command is a one-off request to the OnAir API and is translated into a discord response table. See Planned Features for what's in the works.

How to use

There are now two ways you can start using the bot

Local or server installation where you will need to install node.js version ^18.16 then clone and configure the bot to run on your local system, read more about that here
if you prefer going the docker route, I also now maintain a docker image mikedevita/onairdiscordbot, read more about that here

Manual/Dedicated Machine Method

Note: This assumes that your intended system already has node.js version ^18.16 installed

clone the repository git clone [email protected]:mikedevita/onairdiscordbot.git
install the required nodejs modules npm i
copy .example-env to .env
fill out .env with required information
- Ensure to update DISCORD_TOKEN, DISCORD_CLIENTID, DISCORD_GUILDID, with values from Discord developer website, see this wiki for more info
- Ensure to update the DISCORD_OWNERID and DISCORD_[FLEET,FLIGHTS,FBOS,MEMBERS]_STATUS_CHANNELID objects
- ensure the bot is granted the bot and applications.commands scopes in the Discord developer website
- Update ONAIR_COMPANYID, ONAIR_VAID, ONAIR_APIKEY in the onAir object with values from the OnAir companion app, see this wiki for more info
finally, run the bot by executing npm start

By default the Bot should send a message to the channelId defined in Your discord Server when it comes online. Simply interact with the bot using one of the commands in the Commands section below.

Docker Method

how to use docker run to start the docker container, docker run example
- requires: docker on the intended system
how to use docker-compose to start the docker container, docker-compose example
- requires: docker and docker-compose on the intended system

Quick Start with Docker

Copy the example environment file and rename it to .env:

cp .example-env .env

Edit the .env file and replace all ###_REPLACE_WITH_YOUR_DATA_### values with your actual configuration values.
Pull and run the Docker image:

docker pull mikedevita/onairdiscordbot:latest
docker run -d --env-file .env mikedevita/onairdiscordbot:latest

To check the logs:

docker logs $(docker ps -q -f ancestor=mikedevita/onairdiscordbot:latest)

To stop the bot:

docker stop $(docker ps -q -f ancestor=mikedevita/onairdiscordbot:latest)

Docker Environment Variables

All environment variables from your .env file will be passed to the container. The bot will automatically configure itself based on these variables.

Docker Compose (Alternative Method)

Create a docker-compose.yml file:

version: '3'
services:
  onair-bot:
    image: mikedevita/onairdiscordbot:latest
    container_name: onairdiscordbot
    env_file:
      - .env
    restart: unless-stopped

Then run:

docker-compose up -d

Planned Features

Add cash flow related commands to indicate income vs expense and profit margins, see #2 for more information
Add persistence layer to track data over time and allow for more advanced features, see #8 for more information
- Ability for users to link their Discord account to their OnAir company, see #9 for more information
- polling & alerting functionality for flight & job status changes, see #4 for more information

Feature Requests

Are welcome, simply submit an issue

Help & Support

feel free to reach out to me on discord with any questions about the bot, my discord username is ndboost.

I also idle in the #web-apis channel on OnAir company's official discord server.

Bot Hosting and Paid Support

If you are interested in having this bot hosted for you or would like to pay for additional features & support, please reach out to me via discord to discuss your requirements and get things setup, my username is ndboost.

Bot Commands

All command responses are ephemeral by default, meaning only the user who executed the command can see the response. This can be changed by passing the ephemeral param to any command, see Virtual Airline Details for an example.

Command	Description
/airport	shows details about a given airport
/detail	shows OnAir details about the registered Virtual Airline
/members	shows a list of all members in the registered Virtual Airline
/fleet	shows a list of all aircraft in the registered Virtual Airline
/aircraft	shows details about a given aircraft
/jobs	shows a list of all jobs in the registered Virtual Airline
/flights	shows a list of all flights in the registered Virtual Airline

Virtual Airline Details (/detail :ephemeral?)

Provides basic details about the registered VA such as Name, ICAO, Level, Reputation. In the future will provide more details such as cash flow, etc

Params

Name	Desc	Default
ephemeral	Send the message as an ephemeral message	true

Response

[IMPAL] Imperium Airlines Details
  Level: 7
  XP: 5293 / 7000
  Reputation: 98.37%
  World: Thunder
  Created On: September 8th, 2020
  Last Connected: July 11th, 2023

Airport (/airport :icao)

Provides details of a given airport code. In the future will provide the list of planned Arrival and Departure jobs

Params

Name	Desc	Default
page	Page # to show	1
size	Results per page, max 5	5

Response

[KFFZ] Falcon Fld
Mesa, Arizona, USA
Transition Altitude: 18000
Size: 2
Latitude: 33.460842
Longitude: -111.728325
Elevation: 1377.99

Runways
Name  Type                      Length   Hdg  Lat        Lng
----  ------------------------  -------  ---  ---------  -----------
04R   Asphalt - good condition  5091 ft  39   33.456081  -111.733841
22L   Asphalt - good condition  5091 ft  219  33.464512  -111.721336
22R   Asphalt - good condition  3787 ft  219  33.464672  -111.724762
04L   Asphalt - good condition  3787 ft  39   33.458485  -111.733932

Arrivals
Not working yet

Departures
Not working yet

Members (/members)

lists all of the current VA members

Params

Name	Desc	Default
page	Page # to show	1
size	Results per page, max 5	5

Response

[Code] Company Name           Role        $ Earned      PAX Transported  Cargo Transported  # Flights (Flight Hrs)
----------------------------  ----------  ------------  ---------------  -----------------  ----------------------
⏸️ [BGAV] Braam Aviation       Manager     359,561       9                185573             8 (11.45)
[PNAS] Paden Airways          Dispatcher  0             0                0                  3 (3.91)
[TANG] Tangent Airways        Dispatcher  3,617         0                5316               2 (1.34)
[VMSW] Valley Mountain Skyw   Dispatcher  0             0                0                  4 (3.65)
[JPPA] JaPPa Air              Founder     4,417,315.14  151              2606936            90 (154.93)
[LOON] Loon Airways           Dispatcher  80,314        0                50592              1 (2.48)
[HMOD] Hansens Mekk og Drekk  Manager     683,078.97    1775             128074             42 (51.07)

Fleet (/fleet)

lists all of the fleet for the given VA

Params

Name	Desc	Default
page	Page # to show	1
size	Results per page, max 5	5

Response

There are 6 aircraft currently in the fleet
#  Type  Identifier  Name                                   Status  Current Airport                  Max Payload  Pax E/B/F
-  ----  ----------  -------------------------------------  ------  -------------------------------  -----------  ---------
1  HELO  N7270Y      Airbus H135 Phi Air Medical N380PH     ✅ Idle  EHAM - Amsterdam, Noord-Holland  3150 lbs     7/0/0
2  HELO  N6009K      Airbus H135 Phi Air Medical N380PH     ✅ Idle  LOWS - Salzburg, Salzburg        3150 lbs     7/0/0
3  JET   N9837A      Airbus A320 Neo Asobo                  ✅ Idle  KHST - Homestead, Florida        56385 lbs    0/0/0
4  METL  N4156N      Beechcraft King Air 350i Asobo         ✅ Idle  KINS - Indian Springs, Nevada    6090 lbs     0/0/0
5  JET   N1883M      Cessna Longitude Aviators Club Livery  ✅ Idle  LEMD - Madrid, Madrid            6129 lbs     0/0/0
6  JET   N6526N      Airbus A320 Neo Asobo                  ✅ Idle  EGLL - London, England           56385 lbs    0/0/0

Aircraft Detail (/aircraft :identifier)

Provides details for the given Aircraft by an identifier code

Params

Name	Desc	Default
identifier	Aircraft Identifier Code ICAO

Response

Type  Identifier  Name                            Status  Current Airport                Max Payload  Pax E/B/F
----  ----------  ------------------------------  ------  -----------------------------  -----------  ---------
METL  N1883U      Beechcraft King Air 350i Asobo  ✅ Idle  YBCG - Gold Coast, Queensland  5145 lbs     15/0/0

Jobs (/jobs)

lists all of the pending or in-progress jobs for the given VA

Params

Name	Desc	Default
page	Page # to show	1
size	Results per page, max 5	5

Response

There are 2 pending jobs
Type                Pay       Cargos              Status  Aircraft  Depart  Destin  Current  Distance
------------------  --------  ------------------  ------  --------  ------  ------  -------  --------
Dangerous Material  $762,080  1 leg
                              Valuable Equipment  ✅ Idle  N9837A    KHST    KFTW             991 NM
Goods transport     $1,110    1 leg
                              Dry Ice             ✅ Idle  N4156N    KINS    NV65             17 NM

Flights (/flights)

lists all of the flights for the given VA

Params

Name	Desc	Default
page	Page # to show	1
size	Results per page, max 5	5
aircraftcode	Filter by a specific aircraft code	null
companycode	Filter by a specific company code	null
sortby	How to sort the results	StartTime
sortorder	Order to sort the results	desc
showcompleted	Show completed flights	false

Response

There are currently 50  flights in the VA flight Log
Sorting by StartTime in desc order

Showing page 1 of 10
#  Aircraft  Company  Status         Start Time               End Time                 Depart  Intended Arrival  Actual Arrival
-  --------  -------  -------------  -----------------------  -----------------------  ------  ----------------  --------------
1  N4156N    TANG     ✈️ In Progress  2022-10-22T01:08:01.15                            KPHX    AZ04
2  N9481P    HMOD     ✅ Completed    2022-10-19T19:02:12.837  2022-10-21T19:02:28.583  ENKR    ENAT
3  N9481P    HMOD     ✅ Completed    2022-10-19T17:53:28.467  2022-10-19T18:53:42.89   ENTC    ENKR              ENKR
4  N4816Y    PNAS     ✅ Completed    2022-10-19T00:56:40.583  2022-10-19T01:18:13.06   VDPP    VDKC
5  N4816Y    PNAS     ✅ Completed    2022-10-19T00:52:14.89   2022-10-19T00:55:41.97   VDPP    VDKC

Bot OnAir Status Feed

The bot can automatically update status information for your OnAir company in designated Discord channels. This feature provides real-time updates about your fleet, flights, FBOs, jobs, and members at configurable intervals.

Status Feed Configuration

Each status feed can be configured independently in your .env file:

Fleet Status Feed

DISCORD_FLEET_STATUS_ENABLED=true
DISCORD_FLEET_STATUS_CHANNELID=your_channel_id
DISCORD_FLEET_STATUS_INTERVAL=300000  # Update interval in milliseconds (5 minutes)
DISCORD_FLEET_STATUS_SORTCOLUMN=name  # Column to sort by
DISCORD_FLEET_STATUS_PAGESIZE=5       # Number of items per page

Flights Status Feed

DISCORD_FLIGHTS_STATUS_ENABLED=true
DISCORD_FLIGHTS_STATUS_CHANNELID=your_channel_id
DISCORD_FLIGHTS_STATUS_INTERVAL=300000  # Update interval in milliseconds (5 minutes)
DISCORD_FLIGHTS_STATUS_SORTCOLUMN=startTime  # Column to sort by
DISCORD_FLIGHTS_STATUS_PAGESIZE=5          # Number of items per page

FBOs Status Feed

DISCORD_FBOS_STATUS_ENABLED=true
DISCORD_FBOS_STATUS_CHANNELID=your_channel_id
DISCORD_FBOS_STATUS_INTERVAL=300000  # Update interval in milliseconds (5 minutes)
DISCORD_FBOS_STATUS_SORTCOLUMN=name  # Column to sort by
DISCORD_FBOS_STATUS_PAGESIZE=5       # Number of items per page

Members Status Feed

DISCORD_MEMBERS_STATUS_ENABLED=true
DISCORD_MEMBERS_STATUS_CHANNELID=your_channel_id
DISCORD_MEMBERS_STATUS_INTERVAL=300000  # Update interval in milliseconds (5 minutes)
DISCORD_MEMBERS_STATUS_SORTCOLUMN=name  # Column to sort by
DISCORD_MEMBERS_STATUS_PAGESIZE=5       # Number of items per page

#### Jobs Status Feed

DISCORD_JOBS_STATUS_ENABLED=true DISCORD_JOBS_STATUS_CHANNELID=your_channel_id DISCORD_JOBS_STATUS_INTERVAL=300000 # Update interval in milliseconds (5 minutes) DISCORD_JOBS_STATUS_SORTCOLUMN=name # Column to sort by DISCORD_JOBS_STATUS_PAGESIZE=5 # Number of items per page


### Features
- Automatic updates at configurable intervals
- Customizable sorting and pagination
- Individual channel for each status type
- Enable/disable each feed independently
- Configurable update intervals (in milliseconds)

### Best Practices
- Set reasonable update intervals to avoid rate limiting
- Use dedicated channels for each status type
- Consider your server's size when setting page sizes
- Monitor your bot's performance and adjust intervals accordingly

Name		Name	Last commit message	Last commit date
Latest commit History 93 Commits
.vscode		.vscode
commands		commands
db		db
interfaces		interfaces
lib		lib
messages		messages
refreshers		refreshers
statuses		statuses
types		types
utils		utils
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.example-env		.example-env
.gitignore		.gitignore
Bot.ts		Bot.ts
Dockerfile		Dockerfile
OnAir.ts		OnAir.ts
README.md		README.md
config.ts		config.ts
docker-compose.yml		docker-compose.yml
index.ts		index.ts
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

VAMSApp/OnAirDiscordBot

Folders and files

Latest commit

History

Repository files navigation

OnAir Discord Bot

How to use

Manual/Dedicated Machine Method

Docker Method

Quick Start with Docker

Docker Environment Variables

Docker Compose (Alternative Method)

Planned Features

Feature Requests

Help & Support

Bot Hosting and Paid Support

Bot Commands

Virtual Airline Details (/detail :ephemeral?)

Params

Response

Airport (/airport :icao)

Params

Response

Members (/members)

Params

Response

Fleet (/fleet)

Params

Response

Aircraft Detail (/aircraft :identifier)

Params

Response

Jobs (/jobs)

Params

Response

Flights (/flights)

Params

Response

Bot OnAir Status Feed

Status Feed Configuration

Fleet Status Feed

Flights Status Feed

FBOs Status Feed

Members Status Feed

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Contributors 2

Uh oh!

Languages

Packages