/BGS-Tally

A tool to track and report your Background Simulation (BGS) and Thargoid War (TW) activity in Elite Dangerous, implemented as an EDMC plugin. BGS Tally counts all the work you do for any faction, in any system.

Primary LanguagePythonMIT LicenseMIT

BGS-Tally Logo

BGS-Tally

CodeQL Crowdin GitHub Latest Version Github All Releases Discord

A tool to track and report your Background Simulation (BGS) and Thargoid War (TW) activity in Elite Dangerous, implemented as an EDMC plugin. BGS-Tally counts all the BGS / TW work you do for any faction, in any system.

Based on BGS-Tally v2.0 by tezw21: Original tezw21 BGS-Tally-v2.0 Project

As well as all the BGS tracking from Tez's original version, this modified version includes:

  • Automatic on-foot Conflict Zone tracking (with settlement names)
  • Automatic in-space Conflict Zone tracking
  • TW tracking
  • Logging of interactions with other CMDRs, with automatic Inara lookup for CMDR and Squadron
  • Fleet Carrier materials tracking
  • Fleet Carrier jump tracking
  • Discord-ready information - quick Copy to Clipboard for the Discord text as well as posting directly to Discord
  • An API to send data to other web applications.

Initial Installation and Use

Full instructions for installation and use are here in the wiki →.

Updating from a Previous Version

Since v3, upgrading is fully automatic. However, if you need to do a manual upgrade for some reason, full instructions are here in the wiki →.

Discord Integration

The plugin generates Discord-ready text for copying-and-pasting manually into Discord and also supports direct posting into a Discord server or servers of your choice using webhooks. You will need to create webhook(s) on your Discord server first - instructions for setting up webhooks within Discord are here in the wiki →.

What is Tracked

The plugin includes both automatic and manual tracking of BGS and TW activity data.

Your Personal Activity and Privacy

If you're concerned about the privacy of your BGS activity, note that this plugin does not send your data anywhere, unless you specifically choose to by configuring the Discord Integration or API Integration.

Local Files and Folders

It writes to the following locations, both in the BGS-Tally folder:

  1. activitydata\ - This folder contains all your BGS activity, organised in one file per tick.
  2. otherdata\ - This folder contains other data collected by BGS-Tally, including your currently active list of missions and the CMDRs you have targeted.

All of these files use the JSON format, so can be easily viewed in a text editor or JSON viewer.

(N.B. Older versions of BGS-Tally wrote to Today Data.txt, Yesterday Data.txt and MissionLog.txt in your BGS-Tally folder. If you run BGS-Tally v2.0.0 or later, these files are automatically converted to the new formats inside activitydata\ and otherdata\).

Network Connections

The plugin makes the following network connections:

  1. To EliteBGS to grab the date and time of the lastest tick.
  2. To GitHub to check the version of the plugin to see whether there is a newer version available.
  3. To Inara to anonymously check for available information on targeted CMDRs.
  4. Only if configured by you to a specific Discord webhook on a Discord server of your choice, and only when you explicitly click the Post to Discord button.
  5. Only if configured by you to a specific web application of your choice to send your BGS / TW data for aggregation and analysis, via an API. You have control over whether you approve the initial connection, and can choose to terminate the connection at any time.

Troubleshooting

If you are having problems with BGS-Tally, check out the Troubleshooting page →. If those troubleshooting solutions don't work, feel free to contact me in the #support channel on the BGS-Tally Discord server.

Thank You

And finally, a huge thank you to:

  • All the code contributors - listed here on Github.
  • All the CMDRs who have provided their input, bug reports, feedback and ideas.
  • All the translators who have given their time and effort:
    • French - CMDR Dopeilien and CMDR ThArGos
    • German - CMDR Ryan Murdoc
    • Italian - CMDR FrostBit / @GLWine
    • Portuguese (Portugal) - CMDR Holy Nothing
    • Portuguese (Brazil) - CMDR FelaKuti
    • Serbian (Latin) - CMDR Markovic Vladimir
    • Spanish - CMDR HaLfY47
    • Turkish - CMDR Yu-gen