https://github.com/wpilibsuite/Shuffleboard

A modern dashboard for FRC
https://github.com/wpilibsuite/Shuffleboard

first-frc first-robotics-competition frc robotics

Last synced: about 1 month ago
JSON representation

A modern dashboard for FRC

• Host: GitHub
• URL: https://github.com/wpilibsuite/Shuffleboard
• Owner: wpilibsuite
• License: other
• Created: 2017-05-20T00:38:25.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-12T05:54:08.000Z (2 months ago)
• Last Synced: 2024-11-13T13:32:50.780Z (about 1 month ago)
• Topics: first-frc, first-robotics-competition, frc, robotics
• Language: Java
• Homepage:
• Size: 8.93 MB
• Stars: 80
• Watchers: 17
• Forks: 84
• Open Issues: 75
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-frc - Shuffleboard - A clean Driver Station dashboard for FIRST teams. (Repositories / Java/Kotlin)

README

        
![CI](https://github.com/wpilibsuite/shuffleboard/workflows/CI/badge.svg)

# Shuffleboard

## Structure

Shuffleboard is organized into three base projects: `api`, `app`, and `plugins`. `plugins` has additional

subprojects that the main app depends on to provide data types, widgets, and data sources for basic FRC use.

## Running

Shuffleboard is installed by the FRC vscode extension: [Installation Instructions](https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/wpilib-setup.html).

It can be launched from the WPILib menu in Visual Studio Code (start tool).

It can also be run manually by running the shuffleboard.vbs in `c:\Users\public\wpilib\\tools` (Windows) or

shuffleboard.py in `~/wpilib//tools` (Linux or Mac).

### Requirements

- [JRE 17](https://adoptium.net/temurin/releases/?version=17&package=jre). Java 17 is required.

No other version of Java is supported. Java 17 is installed by the

[WPILib installer](https://github.com/wpilibsuite/allwpilib/releases).

## Building

To run shuffleboard use the command `./gradlew :app:run`.

To build the APIs and utility classes used in plugin creation, use the command `./gradlew :api:shadowJar`

To build the Shuffleboard application, use the command `./gradlew :app:shadowJar`. By default, this will create an

executable JAR for your operating system. To build for another OS, use one of the platform-specific builds:

| OS | Command |

|---|---|

| Windows 64-bit | `./gradlew :app:shadowJar-win64` |

| Windows 32-bit | `./gradlew :app:shadowJar-win32` |

| Mac | `./gradlew :app:shadowJar-mac64` |

| Linux 64-bit | `./gradlew :app:shadowJar-linux64` |

Only the listed platforms are supported

To build _all_ platform-specific JARs at once, use the command `./gradlew :app:shadowJarAllPlatforms`

### Requirements

- [JDK 17](https://adoptium.net/temurin/releases/?version=17). JDK 17 is required.

No other version of Java is supported.