-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #660 from ofekashery/master
Update readme to 2023/24 season
- Loading branch information
Showing
1 changed file
with
42 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,69 @@ | ||
| # Attention: Remote Events | ||
|
|
||
| This is the software used to run **traditional** in-person events. | ||
| This is the software used to run **traditional** in-person events. | ||
|
|
||
| If you are a mentor or team administrator trying to score **remote** event matches, go here: [FTC Remote Scoring](https://ftc-scoring.firstinspires.org) | ||
|
|
||
| Full documentation can be found in the [FTC Scoring Team Guide](https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/scoring-team-guide.pdf) | ||
|
|
||
| A video walkthrough can be found on YouTube: [Remote Event Scoring For Teams](https://www.youtube.com/watch?v=5pGDi_Kq7ks&list=PLEuGrYl8iBm48sXHM8wOIPECDvD1zGgr2) | ||
|
|
||
| # Welcome: Traditional Events | ||
| This GitHub repository can be used to download the _FIRST_ Tech Challenge Live scorekeeper software. Also, if you have a GitHub user account, you can use the ["Issues" database](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) to report and track issues with the software. | ||
|
|
||
| This GitHub repository is used to [report and track issues](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) with the _FIRST_ Tech Challenge Live Scorekeeper Software. | ||
|
|
||
| ## Downloading the software | ||
| The software is available for download under the [Releases page](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases) of this repository. Click on the ["releases" link](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases) towards the upper right hand corner of the [main page](https://github.com/FIRST-Tech-Challenge/scorekeeper) to navigate to the [Releases page](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases). | ||
|
|
||
| <p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/releasesLink.png" width="400"></p> | ||
| <p align="center">Click on the "releases" link to go to the Releases page.</p> | ||
| Starting with the 2022-2023 season, the scoring system is primarily available to download as an installer. The installers can be found at | ||
| `https://ftc-scoring.firstinspires.org/local/<season>` (and `https://ftc-scoring.firstinspires.org/local/<season>-offseason` after the season's world championship when offseason events can be hosted). | ||
|
|
||
| ### Current Links | ||
|
|
||
| | Game | Link | | ||
| | --------------------------------- | ---------------------------------------------------------- | | ||
| | **CENTERSTAGE (2023-2024)** | https://ftc-scoring.firstinspires.org/local/2024 | | ||
| | POWERPLAY (2022-2023) - Offseason | https://ftc-scoring.firstinspires.org/local/2023-offseason | | ||
| | POWERPLAY (2022-2023) | https://ftc-scoring.firstinspires.org/local/2023 | | ||
|
|
||
| The scoring system will autoupdate to the latest available version for the season on launch if connected to the internet. | ||
|
|
||
| ### Choosing the correct installer | ||
|
|
||
| The website will detect the platform you are running on and offer a button to download for that platform. | ||
|  | ||
|
|
||
| Browse the [Releases page](https://github.com/FIRST-Tech-Challenge/scorekeeper/releases) for the version that you are looking for, and click on the appropriate link to download the archived software. The software is stored on the server as an archived .zip or .tar file. Note that most users (Windows and Mac users especially) will want to download the .zip format archive file. Once you have downloaded the archive file, uncompress the file using the appropriate tool on your computer. | ||
| If you need to download for one system from another (e.g. the scoring computer runs Windows but you are downloading on a Mac to put on a flash drive), other systems can be found by clicking on "All platforms". | ||
|  | ||
|
|
||
| <p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/downloadZip.png" width="400"></p> | ||
| <p align="center">Click on the file that you'd like to download.</p> | ||
| If you are downloading for macOS or for Linux and are unsure which download is correct for you, run `uname -m` in a terminal and select the corresponding download. | ||
|
|
||
| Note that you want to download the "FIRST-Tech-Challenge-Live" archive file, and not the "Source code" file. The "Source code" file does not contain any usable content. | ||
| > [!WARNING] | ||
| > While we will address any issues reported through this repository for Linux, we are unable to provide Linux-specific event-day support and therefore encourage running the scoring system on Windows or macOS unless your event has volunteers sufficiently experienced in debugging issues on Linux. | ||
| ### Advanced installer | ||
|
|
||
| In some cases you may not be able to run the provided installer (e.g. security policies on the scorekeeper computer). In those cases you can run the scoring system through a package that is similar to how it was provided in previous seasons. | ||
|
|
||
| There is a download available under the "Advanced" dropdown that works on all platforms. | ||
|  | ||
|
|
||
| > [!NOTE] | ||
| > This requires a global installation of Java 17, which can be [downloaded and installed from here](https://www.azul.com/downloads/?version=java-17-lts&package=jre). | ||
| To launch, extract the zip and open the `FTCLauncher` file on macOS/Linux or the `FTCLauncher.bat` file on Windows. This version of the scoring system still has the same auto-update feature as the installer version. | ||
|
|
||
| ## Documentation | ||
| The user documentation can be found here: | ||
|
|
||
| [FTC Scorekeeper Manual](https://firstinspiresst01.blob.core.windows.net/first-energize-ftc/scorekeeper-guide.pdf) | ||
| The user documentation can be found here: [FTC Scorekeeper Manual](https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/scorekeeper-guide.pdf). | ||
|
|
||
| ## Reporting Issues | ||
| Click on the ["Issues" link](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) towards the upper left hand corner of the main page of this repository to navigate to the [Issue Tracking Database page](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues). If you are logged in to your GitHub user account (which is available for free from GitHub) you can create and reply to issues in the database. | ||
|
|
||
| Click on the ["Issues" link](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues) towards the upper left hand corner of the main page of this repository to navigate to the [Issue Tracking Database page](https://github.com/FIRST-Tech-Challenge/scorekeeper/issues). If you are logged in to your GitHub user account (which is available for free from GitHub) you can create and reply to issues in the database. | ||
|
|
||
| <p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/issues.png" width="400"></p> | ||
| <p align="center">Click on the "Issues" link to go to the Issues page.</p> | ||
|
|
||
| The developers of the software requested that if you encounter a bug, you copy and archive (compress into .zip form) the "db" subdirectory and then create an issue on the Issues database and attach the .zip file to the newly created issue and save the attachment with the issue. The "db" folder is located in the "lib" subfolder. | ||
| The developers of the software requested that if you encounter a bug, you copy and archive (compress into .zip form) the "db" subdirectory and then create an issue on the Issues database and attach the .zip file to the newly created issue and save the attachment with the issue. The "db" folder is located in the "lib" subfolder. | ||
|
|
||
| While you are editing your issue, if you click the link called "selecting them" towards the bottom of the issue window, a dialog box will appear. You can use this dialog box to select a local file from your computer to attach to the issue that you are editing. | ||
| While you are editing your issue, if you click the link called "selecting them" towards the bottom of the issue window, a dialog box will appear. You can use this dialog box to select a local file from your computer to attach to the issue that you are editing. | ||
|
|
||
| <p align="center"><img src="https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/scorekeeper/selectingThem.png" width="600"></p> | ||
| <p align="center">Click on the "selecting them" link to attach a local file to your issue.</p> | ||
|
|