VATcord Docs

VATcord Documentation

Small bot to notify when controllers on VATSIM comes online or goes offline.

Modes

VATCord have two different modes it can operate with, Current and Feed. This is set on a subscription level, but I recommend all subscriptions within a channel to have the same mode.

Current

The Current mode will send messages when controllers go online, one message per controller. When the controller goes offline the message corresponding to that controller will be removed from the channel.

This will not give a notification when the controller goes offline. Use this when you want to display the current state of online controllers within a channel.

It is recommended to restrict channel posting to moderators and the bot when using this mode so you get a good overview of online controllers without the messages being hidden in the channel history.

Feed

The Feed mode will give you a feed of controllers going online and offline. This means that for each sync there will be 0, 1 or 2 messages, containing a list of controllers that went online and controller that went offline.

Use this mode when you want to receive notifications both when controllers go online and when they go offline.

This mode also works well in channels where you also want discussions with users, where it doesn't matter that notification messages gets pushed back in the channel history.

Commands

/vatcord subscribe <prefixes> [<feed|current>]

Subscribes the current channel for updates matching the given prefixes. Multiple prefixes can be separated by commas.

Prefixes are case-insensitive and will be uppercased when stored.

Feed/Current is optional. It defaults to the Current mode.

Examples:

  • /vatcord subscribe EI - Subscribe to all controllers that begin with EI, for example EINN_TWR, EISN_CTR, EIDW_GND, in Current mode
  • /vatcord subscribe EI Feed - Subscribe to all controllers that begin with EI, for example EINN_TWR, EISN_CTR, EIDW_GND, in Feed mode
  • /vatcord subscribe EINN,EIDW - Subscribe to all controllers that begin with either EINN or EIDW. This will create two subscriptions in Current mode.
  • /vatcord subscribe EINN,EIDW Feed - Subscribe to all controllers that begin with either EINN or EIDW. This will create two subscriptions in Feed mode.

/vatcord list

Lists the current subscriptions for the channel. This will also give you the ID needed to run the delete command (see below).

Examples:

  • /vatcord list

/vatcord delete <id> | "all"

Removes a subscription for a channel. The ID can be fetched by using the "list" command above.

Using the ID "all" will remove all subscriptions in that channel.

Examples:

  • /vatcord delete 2 - Delete subscription with ID "2"
  • /vatcord delete all - Delete all subscriptions for the channel

/vatcord clear

Removes all messages from VATcord in the channel you run the command in. Useful when switching from Feed mode to Current, or vice versa.

Examples:

  • /vatcord clear

/vatcord mode <feed|current>

Updates the mode of all subscriptions in the channel. It is recommended that you remove all messages from VATcord in the channel after changing modes, using the clear command (see above).

Examples:

  • /vatcord mode current - Set all subscriptions to "current" mode
  • /vatcord mode feed - Set all subscriptions to "feed" mode