Compare commits

..

34 Commits

Author SHA1 Message Date
Jacob Burroughs
8afc7175aa Update README.md 2024-04-24 22:58:59 -05:00
Jacob Burroughs
7658407f00 Merge pull request #660 from ofekashery/master
Update readme to 2023/24 season
2023-11-02 06:37:25 -05:00
Ofek Ashery
fe9b3a1851 Update readme to 2023/24 season 2023-11-02 11:16:28 +00:00
Jacob Burroughs
129df321dc use correct label casing 2023-03-02 14:07:48 -06:00
Jacob Burroughs
a61d5d3443 Separate issue category for ftc-events 2023-03-02 14:03:09 -06:00
Jacob Burroughs
3c18627718 Create documentation-request.md 2022-11-09 19:40:38 -06:00
Jacob Burroughs
929169b123 Update scorekeeper guide link
Fixes #584
2022-10-27 07:49:17 -05:00
Jacob Burroughs
aa5d6e957c Update README.md 2021-11-30 11:53:31 -06:00
Jacob Burroughs
ed84e31ec9 Fis issue templates 2020-12-17 16:48:11 -06:00
Jacob Burroughs
d58704fb79 Merge pull request #518 from FIRST-Tech-Challenge/build-issue-templates
Update issue templates
2020-12-17 16:37:21 -06:00
Jacob Burroughs
ef81371fea refine templates 2020-12-17 16:35:59 -06:00
Jacob Burroughs
6b07906ded Update issue templates 2020-12-17 16:22:17 -06:00
Craig MacFarlane
fd56dce06b Update README.md 2020-11-09 18:03:35 -08:00
FTC Engineering
9922ab52b1 Update README.md 2019-10-11 07:33:28 -04:00
FTC Engineering
522eac0fb0 Update README.md 2018-11-12 10:03:00 -05:00
FTC Engineering
17c87b8b04 Update README.md 2018-10-18 16:12:44 -04:00
FTC Engineering
fbac67b4fe Update README.md 2018-10-18 14:15:00 -04:00
FTC Engineering
3791a0bc2a Update README.md 2018-10-12 21:11:13 -04:00
FTC Engineering
7d3159fc4c Update README.md 2018-09-13 11:28:58 -04:00
FTC Engineering
a816e47941 Update README.md 2018-09-13 11:28:06 -04:00
FTC Engineering
8bb52e4c16 Update README.md 2018-09-13 10:55:39 -04:00
FTC Engineering
cdf909eab4 Update README.md 2018-09-13 10:54:43 -04:00
FTC Engineering
a478acf440 Update README.md 2018-09-13 10:53:16 -04:00
FTC Engineering
665bfb93e9 Update README.md 2018-09-13 10:50:07 -04:00
FTC Engineering
b7a0428193 Update README.md 2018-09-13 10:47:30 -04:00
FTC Engineering
0a7fb8dad2 Update README.md 2018-09-13 10:46:22 -04:00
FTC Engineering
b4a35d0774 Update README.md 2018-09-13 10:45:44 -04:00
FTC Engineering
9970225e01 Update README.md 2018-09-13 10:43:05 -04:00
FTC Engineering
854b4e30f5 Update README.md 2018-09-13 10:42:22 -04:00
FTC Engineering
2c39e095c5 Update README.md 2018-09-13 10:41:33 -04:00
FTC Engineering
883696fac2 Update README.md 2018-09-13 10:34:48 -04:00
FTC Engineering
37ab1753dd Update README.md 2018-09-13 10:33:15 -04:00
FTC Engineering
01a1f0ef12 Update README.md 2018-09-13 09:28:39 -04:00
FTC Engineering
cd6530394b Update README.md 2018-09-13 09:21:01 -04:00
9 changed files with 240 additions and 5 deletions

View File

@@ -0,0 +1,33 @@
---
name: Cloud Scoring Bug Report
about: Submit a bug in ftc-scoring.firstinspires.org
title: ''
labels: Cloud, bug
assignees: ''
---
<!--- DO NOT INCLUDE PRIVATE INFORMATION IN THIS ISSUE --->
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Device (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,20 @@
---
name: Cloud Scoring Feature Request
about: Suggest an idea for for ftc-scoring.firstinspires.org
title: ''
labels: Cloud, enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1 @@
blank_issues_enabled: false

View File

@@ -0,0 +1,16 @@
---
name: Documentation Update Request
about: Request an addition, correction or update to documentation
title: ''
labels: documentation
assignees: ''
---
** Requested Change **
What you would like to see updated (or added) to documentation
** Relevant existing documentation **
A link to any existing documentation, with page number if appropriate

View File

@@ -0,0 +1,33 @@
---
name: FTC Events Bug Report
about: Submit a bug in ftc-events.firstinspires.org (including ftc-api)
title: ''
labels: ftc-events, bug
assignees: ''
---
<!--- DO NOT INCLUDE PRIVATE INFORMATION IN THIS ISSUE --->
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Device (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,20 @@
---
name: FTC Events Feature Request
about: Suggest an idea for for ftc-events.firstinspires.org (including ftc-api)
title: ''
labels: ftc-events, enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@@ -0,0 +1,33 @@
---
name: Traditional (FTCLive) Bug Report
about: Submit a bug in the traditional scoring system
title: ''
labels: Local, bug
assignees: ''
---
<!--- DO NOT INCLUDE PRIVATE INFORMATION IN THIS ISSUE --->
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Device (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,20 @@
---
name: Traditional (FTCLive) Feature Request
about: Suggest an idea for the traditional scoring system
title: ''
labels: Local, enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@@ -1,11 +1,70 @@
# Welcome! # Attention: Remote 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 feature to report and track issues with the software.
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)
# Welcome: Traditional Events
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 ## Downloading the software
The software is available for download under the Releases page of this repository. Click on the "releases" link towards the upper right hand corner of the main page to navigate to the Release page. Browse the releases page for version you are looking forward, 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. Once you have downloaded the archive file, uncompress the file using the appropriate tool for your computer.
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) - Offseason** | https://ftc-scoring.firstinspires.org/local/2024-offseason |
| 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.
![Download Local Scoring System screenshot](https://ftc-scoring.firstinspires.org/uploads/076a1482-b74a-44c4-b5c4-a6bc506170f4)
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".
![All platforms download section screenshot](https://ftc-scoring.firstinspires.org/uploads/fbcc1663-5c1f-4bfb-8fa0-b757a746adae)
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.
> [!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.
![Advanced download section screenshot](https://github.com/FIRST-Tech-Challenge/scorekeeper/assets/3067361/9371f9c2-06f8-40b9-a06f-17e838c8fa44)
> [!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 ## Documentation
Currently, the user documentation exists as a living Google Drive document. You can access the document using the following link:
&nbsp;&nbsp;[User Documentation for Scorekeeping Software](https://docs.google.com/document/d/1x5OHQiNgm70inQ-FRYEhM0RPY0hKwaQIH3_FfDnf1bw/edit?usp=sharing) 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.
<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.
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>