A Discord bot to look up stats and information from Planetside 2

The bot can be added to your server with this invite link.

The main event listener is in main.js, it starts additional listeners in unifiedWSListener.js which each listen for subscribe commands and events from the Daybreak Stream API for a given platform (PC, PS4US, PS4EU). Most commands are separated into their own files, and utilize async to support high message volume.

The bot is designed to be simple to use. Once added to your server with the invite link, commands can be viewed with "!help". In order to get the most out of the bot, please grant it the "Read Messages", "Send Messages", and "Embed Links" permissions.

If you would like to deploy your own version of the bot, it is designed to run on Heroku. Running locally is available, as long as you provide a Discord token and Daybreak Census API service ID in an auth.json file. Subscription functionality will be disabled if run this way.

For feedback or error reports, the best ways to contact are reddit (/u/RemainNA), Discord (RemainNA#0159), and the Auraxis bot Discord server.

There are three main ways to support development:

If you identify a bug, report it in the Discord server. Github issues are not used in development, and are not closely monitored.

If you have experience programming in Node.js and would like to contribute code directly, consider reaching out on the platforms listed above.

Finally, if you would like to contribute financially, there is a Ko-fi associated with this project:

Any support, including just a few kind words, is greatly appreciated!

Returns a list of commands and relevant links.

Returns the details (BR, Score, Server, Outfit, etc.) of the specified character. Supports multiple characters per query.

Returns the details (Name, owner, faction, server, member count, etc.) of the specified outfit tag. Supports multiple tags per query.

Returns the list of all online members for the specified outfit tag. Supports multiple tags per query.

Subscribes the channel to notifications of alerts starting on the specified servers. Supports multiple servers per query. Supports all platforms without prefixes.

Unsubscribes the channel from the above notifications. Supports multiple servers per query. Supports all platforms without prefixes.

Subscribes the channel to notifications of logins and logouts of members in the specified outfit tag. Supports multiple tags per query.

Unsubscribes the channel from the above notifications. Supports multiple tags per query.

Unsubscribes the channel from all outfit activity and server alert notifications.

Returns the population per faction of the specified server. Supports multiple servers per query. Supports all platforms without prefixes

Returns the territory control of each continent on the specified server. Supports multiple servers per query. Supports all platforms without prefixes

Return the current status of all servers as reported by the Census API. Takes no parameters.

Currently in beta. Returns information on a given weapon. Accepts weapon IDs, exact names, or partial names. Only supports one weapon per query.

Returns information on given implant. Accepts exact or partial names. Only supports one implant per query.

Returns the BR a character reached before joining ASP. Only supported on PC, does not work with NSO.