Skip to content

NRG948/nrgcommon

Repository files navigation

FRC Team 948 - NRG Common Java Library

Javadoc

This repository contains common code that is shared among robots created by FRC Team 948 - Newport Robotics Group (NRG).

Releases

The table below lists the published versions of the library and the WPILib release version required to use it.

Version Git Tag/Branch Required WPILib Version
2026.3.1-SNAPSHOT main 2026.2.1
2026.2.4 v2026.2.4 2026.2.1
2025.3.2 v2025.3.2 2025.3.2
2025.1.0 v2025.1.0 2025.1.1
2024.3.1 v2024.3.1 2024.3.1
2023.4.0 v2023.4.0 2023.4.2
2023.2.0 v2023.2.0 2023.2.1
2022.1.0 v2022.1.0 2022.4.1

How to use the library in a Robot project

The library is published to GitHub Packages. Because GitHub Packages requires authentication even for installing packages, you will need to first create a personal access token. The token only needs the packages:read scope.

Once you have created the token, add the following entries to $HOME/.gradle/gradle.properties replacing USERNAME with your GitHub user name and TOKEN with the token value itself.

gpr.user=USERNAME gpr.key=TOKEN

Next, add the NRG Common package repository to your build.gradle file. Use of the Elvis operator (?:) to get the GitHub Actor and Token is optional but enables the library to be consumed when the code is built during a GitHub Action.

repositories { maven { url = uri("https://maven.pkg.github.com/NRG948/nrgcommon") credentials { username = project.findProperty("gpr.user") ?: System.getenv("GITHUB_ACTOR") password = project.findProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN") } } }

Finally, add the NRG Common Java Library and its annotation processor as dependencies in your build.gradle file.

def nrgcommon = [ version: 2026.2.4 ] dependencies { annotationProcessor "com.nrg948:nrgcommon-processor:${nrgcommon.version}" implementation "com.nrg948:nrgcommon:${nrgcommon.version}" }

NOTE: If you want the latest build from main, use version '2026.3.1-SNAPSHOT'. There may be breaking changes and it certainly will not be as stable, so use with caution.

On the next build, the library will be downloaded from GitHub packages and installed in the Gradle build cache.

About

Common Java code for NRG robots.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages