Skip to content

The user interface client tracker that handles local parsing to send data to Gathering.gg

License

Notifications You must be signed in to change notification settings

gathering-gg/client

Repository files navigation

Gathering.gg Client

This repo contains a user interface for handling the parsing of Magic: The Gathering Arena output_log.txt files. The actual parsing is handled by the Parser library. However, that library is a command line utility and not very user friendly (unless you love Powershell).

The Electron app also handles most of the operating system hooks we want our tracker to have, such as starting on login, tray icon, and notifications.

Get Started

Download the latest release: https://github.com/gathering-gg/client/releases

Note: It does not currently auto update, but when it does, it will still use GitHub releases to check for updates.

Unzip the app and install it. Go to Gatherin.gg to get your account token and input it into the app. You're good to go!

Development

Client uses Electron Forge to handle the Electron lifecycle. You'll want to install it to develop locally.

$ npm install -g electron-forge

Clone the repo and install dependencies

$ git@github.com:gathering-gg/client.git && cd client
$ yarn

Note: We use Yarn for dependency management in this app, do not run npm install

Run Local:

$ make

The app has a configuration file that is changed between dev/prod depending on the Make command being run. This configuration file changes the root url the app talks to and may be of interest to chage.

Lint:

yarn lint

Deploying a new Version

$ git pull

Ensure package.json reflects the version you want to release. If not, update it.

$ make clean

Go to parser releases and download the latest release for Windows. Unzip it.

$ cp ~/Downloads/gathering_version_exe resources/windows/gathering.exe

Finally

electron-forge make --arch=x64

Contributing

Please feel free to submit issues and pull requests!

Other Log Path Locations

  • Linux/Wine: /home/$(whoami)/Games/magic-the-gathering-arena/drive_c/users/$(whoami)/AppData/LocalLow/Wizards Of The Coast/MTGA/output_log.txt
  • macOS/Wine /Applications/MTGArena.app/Contents/Resources/drive_c/users/Wineskin/AppData/LocalLow/Wizards\ Of\ The\ Coast/MTGA/output_log.txt