Installation

Add FrcCatalyst to your WPILib robot project.

Table of contents

  1. Prerequisites
  2. Option 1: JitPack (Recommended)
  3. Option 2: Local Maven (From Source)
  4. Verify Installation
  5. Next Steps

Prerequisites

  • WPILib 2026 installed (download)
  • CTRE Phoenix 6 vendordep installed in your robot project
  • A GradleRIO robot project (created via WPILib project generator)

Add the JitPack repository and FrcCatalyst dependency to your robot project’s build.gradle:

repositories {
    // ... your existing repositories ...
    maven { url "https://jitpack.io" }
}

dependencies {
    // ... your existing dependencies ...
    implementation "com.github.TomAs-1226:FrcCatalyst:v0.2.0-beta"
}

Option 2: Local Maven (From Source)

If you prefer to build from source or need to modify the library:

# Clone FrcCatalyst
git clone https://github.com/TomAs-1226/FrcCatalyst.git
cd FrcCatalyst

# Publish to local Maven
./gradlew publishToMavenLocal

Then in your robot project’s build.gradle:

repositories {
    mavenLocal()
}

dependencies {
    implementation "com.frccatalyst:FrcCatalyst:0.2.0-beta"
}

Verify Installation

Create a simple test in your RobotContainer to confirm everything is working:

import frc.lib.catalyst.hardware.MotorType;
import frc.lib.catalyst.util.CatalystMath;

// In your RobotContainer constructor:
System.out.println("Kraken X60 free speed: "
    + MotorType.KRAKEN_X60.freeSpeedRPS() + " RPS");
System.out.println("Processed joystick: "
    + CatalystMath.processJoystick(0.5, 0.05, 2.0, 1.0));

If it compiles and prints the values, you’re good to go!

Next Steps

Head to the Quick Start guide to build your first mechanism in under 5 minutes.


Back to top

Built for the FRC community. Go build something awesome.

This site uses Just the Docs, a documentation theme for Jekyll.