willbarkoff / autoscout

πŸ”Ž Automatic scouting for First Tech Challenge teams

Home Page:https://willbarkoff.dev/autoscout/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FTC Autoscout

Automatic scouting for First Tech Challenge Teams

Go version Latest release Latest release (including pre-release) Build Status License Created By


Autoscout provides data about FTC teams at a given competition.

It currently supports 2 score reporting platforms:

While I'd love to support FTC Scores in the future, currently, it isn't supported.

In the directory that you are running the program from, create a file called config.toml. This file contains the configuration infromation for the server. A sample config file is available in the config.sample.pennfirst.toml file.

Populate the file as demonstrated below:

[Stats]
Type = "Penn FIRST" # Must be "Penn FIRST"
URL = "http://detroit.worlds.pennfirst.org/" # The URL used for score reporting
division = "Edison" # The division to scout for.

In the directory that you are running the program from, create a file called config.toml. This file contains the configuration infromation for the server. A sample config file is available in the config.sample.toa.toml file.

Populate the file as demonstrated below:

[Stats]
Type = "TOA" # Must be "TOA"
TOAKey = "secret TOA key" # Your TOA Key
TOAOrigin = "Autoscout" # Leave this line as "Autoscout"
TOAEventKey = "TOA event key" # The event key for TOA

You can find your TOA key in the your account page. First, register or sign in, then click "Generate API Key," and copy and paste the generated API key.

The TOA Event Key can be found in the URL of the event, for example, the URL of the results page for the 2020 New York City Championship is https://theorangealliance.org/events/1920-NY-NFTCC/rankings, and the event key is 1920-NY-NFTCC.

Building from Source

To build from source, you must have The Go Programming Language installed. You can install Go at their website: golang.org.

To download the source, you can type

$ go get github.com/willbarkoff/autoscout # get the source
$ cd src/github.com/willbarkoff/autoscout # cd into the source

Then, install dependencies:

$ go get

Finally, compile and run

$ go install
$ ../../../../bin/autoscout

Pull requests are welcome!

About

πŸ”Ž Automatic scouting for First Tech Challenge teams

https://willbarkoff.dev/autoscout/

License:MIT License


Languages

Language:Go 100.0%