sc2-rsu

command module
v0.0.0-...-c1607c5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2020 License: MIT Imports: 1 Imported by: 0

README

SC2ReplayStats Uploader

MIT License Go Version Maintainability
CI GoReportCard Coverage Status

GUI Screenshot

CLI Screenshot

Features

  • Cross-Platform: Full Linux and Windows support, Mac OS X untested
  • Bronze Friendly: login command accepts an API Key or Email Address
  • Optimized Build: Requires no vespene, and less than 30MB of RAM

Missing a feature? Request it!

Usage

Using the Graphical Interface
  1. Download a Release or Get the Sources
  2. Run the program without a command to open the Graphical User Interface
  3. Follow the on-screen First-Time Setup to get started!
Using the Command-Line Interface
  1. Download a Release or Get the Sources
  2. Issue the login command to perform one-time setup (get your SC2ReplayStats API Key)
  3. Run the program with the --text switch to automatically upload games as they are played
$ sc2-rsu login john@doe.com
  Password for sc2ReplayStats account john@doe.com:
  Success! Logged in to account #9001
  API Key set in configuration!

$ sc2-rsu
  Starting Automatic Replay Uploader...
  Ready!

For full usage instructions, consult the --help output.

Building From Source

  1. Install Golang
  2. Clone the repository
  3. Run make
# Install Golang [apt / yum / dnf install golang]
$ git clone https://github.com/AlbinoGeek/sc2-rsu
$ cd sc2-rsu
$ make all

The binary will be built into the _dist directory.

License

This project is licensed under the terms of the MIT License.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
Code generated by go generate; DO NOT EDIT.
Code generated by go generate; DO NOT EDIT.
gui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL