https://github.com/Celeo/staff_up_bot
Discord bot to alert when VATSIM airports have traffic but no controllers
https://github.com/Celeo/staff_up_bot
deno discord vatsim
Last synced: about 1 year ago
JSON representation
Discord bot to alert when VATSIM airports have traffic but no controllers
- Host: GitHub
- URL: https://github.com/Celeo/staff_up_bot
- Owner: Celeo
- License: mit
- Created: 2022-09-04T04:35:03.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-26T02:38:39.000Z (over 3 years ago)
- Last Synced: 2025-04-22T16:23:11.909Z (about 1 year ago)
- Topics: deno, discord, vatsim
- Language: TypeScript
- Homepage:
- Size: 30.3 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-vatsim - Staff Up Bot
README
# staff_up_bot
[](https://github.com/Celeo/staff_up_bot/actions?query=workflow%3ACI)
[](LICENSE)
[](https://deno.land/)
Discord bot to alert when VATSIM airports have traffic but no controllers.
When running, the bot will check pilot positions every 2 minutes and for each configured entry,
count the number of pilots within 5 nm of each airport. If the number of pilots within that
distance is greater than the threshold, and the airport isn't being covered by an online
controller matching the list, then a simple text message is sent to the Discord channel,
specifying the airport, the number of pilots nearby, and the threshold.
## Installing
### From binary
Get a binary from the [repo](https://github.com/Celeo/staff_up_bot/releases).
### From Source
1. Install [Deno](https://deno.land)
1. Install [just](https://github.com/casey/just)
1. Clone the repo
1. Build with `just compile`
## Using
1. Copy the `config.example.json` file to `config.json` and populate
1. Run the binary
## Configuration
### Fields
- The "token" field is your [Discord bot token](https://discord.com/developers/applications)
- The "channel" field is the [Discord channel](https://turbofuture.com/internet/Discord-Channel-IDp) to which you want alerts to be sent
- The "alerts" field is an array of alerts that you want the bot to look for. Fields:
- "airport" - the ICAO identifier, i.e. "KSAN"
- "trafficThreshold" - the minimum number of pilots nearby to trigger an alert for
- "coveringPositions" - a list of regex strings to check that would be staffing the airport
### Example config
```json
{
"token": "abc123",
"channel": "456789",
"alerts": [
{
"airport": "KSAN",
"trafficThreshold": 10,
"coveringPositions": ["SAN_.*TWR", "SAN_.*APP", "SCT_.*APP", "LAX_.*CTR"]
},
{
"airport": "KLAX",
"trafficThreshold": 10,
"coveringPositions": [
"LAX_.*TWR",
"LAX_.*APP",
"LAX_.*DEP",
"SCT_.*APP",
"LAX_.*CTR"
]
},
{
"airport": "KLAS",
"trafficThreshold": 10,
"coveringPositions": ["LAS_.*TWR", "LAS_.*APP", "LAX_.*CTR"]
}
]
}
```
## License
- Bot under MIT ([LICENSE](LICENSE)).
- Libraries in use under their respective licenses.
## Contributing
Please feel free to contribute. Please open an issue first (or comment on an existing one) so that I know that you want to add/change something.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.