Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 2.02 KB

README.md

File metadata and controls

74 lines (56 loc) · 2.02 KB
Raw

TitanUtil

Documentation

A collection of utility classes to make robot programming easier. Do not riddle yourself with redundant and repetitive code when you have a library that will do all of the grunt work for you.

Features

Current features include:

Core

  • Motor toggling
  • Built-in joystick deadzoning
  • Xbox and drone controller button mapping
  • Game data parser

Robot

  • Command based robot control
  • Axis command groups (useful for driving)
  • Builtin core utilities
  • Added Components and Cross-Class Sensor Data

Mimic

  • Observing and Mimicing basic drivebase pathfinding data
  • Saving mimic data to a flash drive
  • Loading mimic data from a flash drive
  • Portability to add more complex mechanisms like intakes

Install

The supported way of introducing TitanUtil to a project is via Gradle. Gradle is the current build system for WPILib robot projects.

To install as a vendordep:

  1. Open WPILIB Vscode

  2. Open the command pallete by pressing Ctr+Shift+P

  3. Select Manage Vendordeps

  4. Then select Install New Libraries (Online)

  5. Put the following in the input field:

https://raw.githubusercontent.com/frc5431/TitanUtil/master/TitanUtil.json

To install, add the following to the root build.gradle

allprojects {
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

and, add the dependency (Make sure it's the latest release)

dependencies {
    implementation 'com.github.frc5431:TitanUtil:2024.1.0' //Replace tag with the latest release if needed
}

License

BSD 2-Clause License

Copyright (c) 2024, 5431 Titan Robotics All rights reserved

Refer to LICENSE file for more information, located in the base of this project