Installing Software - hammerheads5000/Team-Documentation GitHub Wiki
WPILib Installation
- Download and open installer
- Select install "Everything"
- "Download for this computer only"
Useful Extensions
Go to the sidebar icon that looks like 3 blocks, and search for extensions to install. None of these are necessary, just very useful.
- GitLens - Very useful, helps manage Git repositories
- Git Graph - A nice way of visualizing and managing Git version history and branches This is where you will edit the code
NI Game Tools
This includes FRC Driver Station, how you can connect to and control the robot. Note that it takes a long time to download, especially on slow school wifi.
Setting up GitHub
First, create an account and, if you wish to work on the code, make sure you are added to the organization and given permissions. See the GitHub Quickstart Guide.
GitHub Desktop
A simple interface for using GitHub is GitHub Desktop, which is useful if you do not want to use the command-line interface (CLI). Simply install, login, and clone the appropriate repository, either by choosing from the list or copying the URL.
Command-Line Interface
For more in-depth control, use the CLI. It requires some technical knowledge but is much more flexible. Simply install git and use your preferred terminal.
GitLens
Similar to GitHub Desktop, you can use a visual interface, but only in VSCode. More in-depth than just GitHub Desktop, but probably not to be used alone. See Useful Extensions
CTRE
We use many CTRE (Cross The Road Electronics) products, such as motors.
Phoenix Framework
This includes the libraries you will need to use the code. Download the Phoenix Framework Installer for your appropriate OS. Note that we do not use LabVIEW, so you only need the Java libraries.
Once installed, you can add the library to your projects by going to the command pallet in VSCode (Ctrl+Shift+P or the WPILib icon in the top right) and selecting "Manage Vendor Libraries". To install a library into a project, select "Install New Libraries (Offline)" and adding "Phoenix (v5 and Pro)".
Selecting another option (just v5 or Pro) can lead to incompatibilities, so make sure to select v5 and Pro.
Phoenix Tuner X
Used to manage devices and firmware, only necessary for managing electronic devices. Not needed if only coding. Install from respective app store.
Path Planner
Used to create auto paths. Also comes with a library to install into project. Not necessary if not doing auto.