WPILib Installation Guide¶
This guide is intended for Java and C++ teams. LabVIEW teams can skip to Installing LabVIEW for FRC (LabVIEW only). Additionally, the below tutorial shows Windows 10, but the steps are identical for all operating systems. Notes differentating operating systems will be shown.
You can download the latest release of the installer from GitHub. Ensure that you download the correct binary for your OS and architecture.
Windows 7 users must have an updated system with this update installed.
Extracting the Installer¶
When you download the WPILib installer, it is distributed as a disk image file
.iso for Windows,
.tar.gz for Linux, and distributed as a
DMG for MacOS.
Running the Installer¶
Upon opening the installer, you’ll be presented with the below screen. Go ahead and press Start.
This next screen involves downloading VS Code. Unfortunately, due to licensing reasons, VS Code can not be bundled with the installer.
Download VS Code for Single Install
This downloads VS Code only for the current platform, which is also the smallest download.
Skip installing VS Code
Skips installing VS Code. Useful for advanced installations or configurations. Generally not recommended.
Use Downloaded Offline Installer
Selecting this option will bring up a prompt allowing you to select a pre-existing zip file of VS Code that has been downloaded by the installer previously. This option does not let you select an already installed copy of VS Code on your machine.
Download VS Code for Offline Install
This option downloads and saves a copy of VS Code for all platforms, which is useful for sharing the copy of the installer.
Go ahead and select Download VS Code for Single Install. This will begin the download process and can take a bit depending on internet connectivity (it’s ~60MB). Once the download is done, select Next. You should be presented with a screen that looks similar to the one below.
This showcases a list of options included with the WPILib installation. It’s advised to just leave the default options selected.
You will notice two buttons, Install for this User and Install for all Users. Install for this User only installs it on the current user account, and does not require administrator privileges. However, Install for all Users installs the tools for all system accounts and will require administrator access. Install for all Users is not an option for macOS and Linux.
Select the option that is appropriate for you, and you’ll presented with the following installation screen.
After installation is complete, you will be presented with the finished screen.
Congratulations, the WPILib development environment and tooling is now installed on your computer! Press Finish to exit the installer.
Some operating systems require some final action to complete installation.
Installing desktop tools and rebooting will create a folder on the desktop called
YYYY WPILib Tools, where
YYYY is the current year. Desktop tool shortcuts are not available on Linux and MacOS.
What is Installed?¶
The Offline Installer installs the following components:
Visual Studio Code - The supported IDE for 2019 and later robot code development. The offline installer sets up a separate copy of VS Code for WPILib development, even if you already have VS Code on your machine. This is done because some of the settings that make the WPILib setup work may break existing workflows if you use VS Code for other projects.
C++ Compiler - The toolchains for building C++ code for the roboRIO
Gradle - The specific version of Gradle used for building/deploying C++ or Java robot code
Java JDK/JRE - A specific version of the Java JDK/JRE that is used to build Java robot code and to run any of the Java based Tools (Dashboards, etc.). This exists side by side with any existing JDK installs and does not overwrite the JAVA_HOME variable
WPILib Tools - SmartDashboard, Shuffleboard, Robot Builder, Outline Viewer, Pathweaver
WPILib Dependencies - OpenCV, etc.
VS Code Extensions - WPILib extensions for robot code development in VS Code
WPILib is designed to install to different folders for different years, so that it is not necessary to uninstall a previous version before installing this year’s WPILib. However, the following instructions can be used to uninstall WPILib if desired.