Getting started - Varunda/topt-core GitHub Wiki

At the core of topt-core, is a class called Core. This Core object is what manages all connections, tracking and data processing. To get raw data from topt, you'll be interacting with the Core object.

Starting a Core object

const core: Core = new Core(serviceID, serverID);

The service ID is what you use for everything else to interact with Census, and the serverID is what ID of the server to listen to server-wide events, such as login and out, router destructions, facility captures, anything where we can't listen to a specific set of characters.

await core.connect();

Calling .connect() will return a Promise that resolves once Core has connected to Census and sockets have been setup. Once connected, you can then add outfits and players to track. If you attempt to add before Core is connected, an error is thrown.

await core.connect();
await core.addOutfit("t1de"); // Track all players in an outfit
await core.addOutfit("varunda"); // Track a specific player

core.start(); // Start tracking and recording events

await core.addOutfit("bwae"); // You can add outfits and players while tracking as well

There is currently no way to remove an outfit or player

Stat generation

Once you've collected the data you want, there's a couple different reports that can be generated to look at. You've got an outfit report, winter report, and personal report

Outfit report

An outfit report is an overview of how all tracked players did during an period of time.

Winter report

A winter report is a quick board of the top players in many different metrics. Most kills, most heals, most revives, most resupplies, etc.

Personal report

A personal report is an in depth report at how a single individual did during an op.

Battle report

A report that requires a special program to track properly. Uses manually inserted markers to generate stats on a per fight basis.

Asteroid report

A report that focuses on logistics and vehicle fights. Designed specifically for Desolation and Outfit Wars, but may be useful outside as well