Skip to content
This repository has been archived by the owner on Jan 7, 2024. It is now read-only.

Tigerbotics7125/TigerLib

Repository files navigation

TigerLib is now archived, files may still be used, but development has stopped.

Build Lint Publish Documentation


What is TigerLib?

TigerLib is a FRC library which holds many different utilities for programming a FRC robot. These utilities include many tools such as OI tools, and Math functions.

Installation

This is assuming you have already created a wpilib / gradle project.

  1. Open the build.gradle file.

  2. Add or edit the following lines to use Java 17.

sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17
  1. Add the following to add the required repositories to your project.
repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
    maven {
        url 'https://maven.photonvision.org/repository/internal'
    }
    maven {
        url 'https://maven.photonvision.org/repository/snapshots'
    }
}
  1. Add the dependency within the dependencies block.

GitHub release (latest SemVer) GitHub release (latest SemVer including pre-releases)

dependencies {
    // check icons above for most recent version
    // do not include the 'v' in the version.
    implementation 'com.github.Tigerbotics7125:tigerlib:VERSION'
    // ex: implementation 'com.github.Tigerbotics7125:tigerlib:2023.0.0'

    // ... other dependencies
}
  1. Execute a the gradle build task, either in your terminal with ./gradlew build or with the VSCode extension (Ctrl/Cmd + Shift + P, then search for: > Gradle: Run a Gradle Build).

Support

Code documentation and usage examples are available below:

If you still need help, create an issue here.

Contribution

  1. Fork this repo.
  2. Make your changes.
  3. Start a pull request.

All changes need to be commited atomicly and documented fully.

Acknowledgments

Lines of code

  • In numerical order:
  • StuyPulse 694 - Conversion class.
  • Spectrum 3847 - Some OI concepts.

Contributors