Installation
New Projects
For new projects, we highly recommend starting with one of the template projects attached to the latest release. These projects include detailed documentation and setup instructions for many common use cases:
- 2024 KitBot Template: For robots based on the 2024 FIRST KitBot.
- Differential Drive Template: For other differential drive (tank) robots.
- Spark Swerve Template: For swerve drives primarily using the Spark Max and Spark Flex, including NEO, NEO Vortex, or NEO 550 motors.
- TalonFX Swerve Template: For swerve drives primarily using TalonFX-based motors like the Falcon 500, Kraken X60, and Kraken X44.
- Vision Template: Example code for running simple vision targeting and pose estimation.
- Skeleton Template: Simple project with AdvantageKit installed but without subsystems or control logic.
Existing Projects
Users wishing to install AdvantageKit in an existing project should check the documentation page for existing projects.
Offline Installation
Maven artifacts for AdvantageKit can be downloaded and installed for offline use. This allows AdvantageKit to be accessed even if GitHub Packages is blocked on school networks.
- Download the "maven_offline.zip" asset attached to the latest GitHub release.
- Unzip the file into "C:\Users\Public\wpilib\YEAR\maven" on Windows or "~/wpilib/YEAR/maven" on macOS/Linux.