Giter Club home page Giter Club logo

client's Introduction

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

$ [email protected]: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

client's People

Contributors

bmick avatar ethanmick avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

bmick

client's Issues

No App Icon on macOS

I literally cannot figure this out. I've tried every configuration. If anyone has any idea, let me know!

Show daily break down of matches.

It would be great to be able to see somewhere how you did on a specific day. For example, what was your W/L ratio for yesterday, what decks did you play, etc.

Show Update in Client

If an update is available, show that as well in the client. Have a link to the release page.

Check for Updates

While it can't autoupdate without a certificate (We'll get there, I just want this project have more users first), it would be nice to check for updates and popup a notification.

Add Menu to Tray Icon

Displays on Click or Right Click:
Needs:

  1. Exit App
  2. Show App
  3. Gathering.gg/user
  4. Gatherring.gg/matches
  5. Gathering.gg/decks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.