NCGEARS/cheesy-arena-lite
1
0
Fork 0
mirror of https://github.com/Team254/cheesy-arena-lite.git synced 2026-03-09 13:46:44 -04:00
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Update README and TODO.

Browse Source
This commit is contained in:
Patrick Fairbank
2020-04-25 15:42:59 -07:00
parent e690f34993
commit 1b810f7d80
2 changed files with 10 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,6 +1,8 @@
Cheesy Arena [![Build Status](https://travis-ci.org/Team254/cheesy-arena.svg?branch=master)](https://travis-ci.org/Team254/cheesy-arena) Cheesy Arena Lite [![Build Status](https://travis-ci.org/Team254/cheesy-arena.svg?branch=lite)](https://travis-ci.org/Team254/cheesy-arena)
============ ============
A field management system that just works. A game-agnostic field management system that just works.
For the game-specific version, switch to the `master` branch or see [Cheesy Arena](https://github.com/Team254/cheesy-arena/tree/master).
## Key features ## Key features
**For participants and spectators:** **For participants and spectators:**
@@ -23,19 +25,11 @@ A field management system that just works.
## License ## License
Teams may use Cheesy Arena freely for practice, scrimmages, and off-season events. See [LICENSE](LICENSE) for more details. Teams may use Cheesy Arena freely for practice, scrimmages, and off-season events. See [LICENSE](LICENSE) for more details.
## Installation and use
**Via binaries:**
1. Download the [latest release](https://github.com/Team254/cheesy-arena/releases) for OS X or Windows
1. Unzip the file
1. On Mac OS X, run `cheesy-arena.command`, and on Windows, run `cheesy-arena.exe`
1. Navigate to http://localhost:8080 in your browser (Google Chrome recommended)
**From source:** **From source:**
1. Download [Go](http://golang.org/doc/install) 1. Download [Go](https://golang.org/doc/install)
1. Set up your [Go workspace](http://golang.org/doc/code.html) 1. Set up your [Go workspace](https://golang.org/doc/code.html)
1. If you're using Windows and don't already have a working version of GCC (needed to compile a dependency), install [TDM-GCC](http://tdm-gcc.tdragon.net). 1. If you're using Windows and don't already have a working version of GCC (needed to compile a dependency), install [TDM-GCC](https://jmeubank.github.io/tdm-gcc/).
1. Download the Cheesy Arena source and dependencies with `go get github.com/Team254/cheesy-arena` 1. Download the Cheesy Arena source and dependencies with `go get github.com/Team254/cheesy-arena`
1. Compile the code with `go build` 1. Compile the code with `go build`
1. Run the `cheesy-arena` or `cheesy-arena.exe` binary 1. Run the `cheesy-arena` or `cheesy-arena.exe` binary
@@ -46,7 +40,7 @@ Teams may use Cheesy Arena freely for practice, scrimmages, and off-season event
Set the IP address of the computer running Cheesy Arena to 10.0.100.5. Driver stations will broadcast their presence on the network to this hardcoded address so that the FMS does not need to discover them by some other method. Set the IP address of the computer running Cheesy Arena to 10.0.100.5. Driver stations will broadcast their presence on the network to this hardcoded address so that the FMS does not need to discover them by some other method.
## Under the hood ## Under the hood
Cheesy Arena is written using [Go](http://golang.org), a relatively new language developed by Google. Go excels in the areas of concurrency, networking, performance, and portability, which makes it ideal for a field management system. Cheesy Arena is written using [Go](https://golang.org), a relatively new language developed by Google. Go excels in the areas of concurrency, networking, performance, and portability, which makes it ideal for a field management system.
Cheesy Arena is implemented as a web server, with all human interaction done via browser. The graphical interfaces are implemented in HTML, JavaScript, and CSS. There are many advantages to this approach – development of new graphical elements is rapid, and no software needs to be installed other than on the server. Client web pages send commands and receive updates using WebSockets. Cheesy Arena is implemented as a web server, with all human interaction done via browser. The graphical interfaces are implemented in HTML, JavaScript, and CSS. There are many advantages to this approach – development of new graphical elements is rapid, and no software needs to be installed other than on the server. Client web pages send commands and receive updates using WebSockets.
@@ -91,5 +85,6 @@ In addition, the following individuals have contributed to make Cheesy Arena a r
* Ken Mitchell * Ken Mitchell
* Andrew Nabors * Andrew Nabors
* Jared Russell * Jared Russell
* Ken Schenke
* Austin Schuh * Austin Schuh
* Colin Wilson * Colin Wilson

9
TODO.md
View File

@@ -18,16 +18,9 @@ Cheesy Arena To-Do List
* Referee interface: add timer starting at field reset to track time limit for calling timeouts/backups * Referee interface: add timer starting at field reset to track time limit for calling timeouts/backups
* Mobile compatibility for announcer display * Mobile compatibility for announcer display
### Cheesy Arena Lite - a game-agnostic version
* Configurable match period timing
* Realtime scoring: just a simple single number input, plus API
* Final score screen: just show point total and remove breakdowns
* Genericize logos
* Manual input of match name
* Remove match scheduling and team standings functionality
### Development tasks ### Development tasks
* Generate more schedules and find an automated way to evaluate them * Generate more schedules and find an automated way to evaluate them
* Switch to a more modern JavaScript paradigm than jQuery, such as ES6
* JavaScript unit testing * JavaScript unit testing
* Fix Handlebars and golang html/template confict * Fix Handlebars and golang html/template confict
* [Selenium](http://www.seleniumhq.org) testing * [Selenium](http://www.seleniumhq.org) testing