Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuypulse/stuylib
Award-Winning FRC Library by StuyPulse Team 694
https://github.com/stuypulse/stuylib
frc frc-java frc-library gradle jitpack math robot robotics
Last synced: about 18 hours ago
JSON representation
Award-Winning FRC Library by StuyPulse Team 694
- Host: GitHub
- URL: https://github.com/stuypulse/stuylib
- Owner: StuyPulse
- License: mit
- Created: 2011-07-01T03:23:12.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T04:57:44.000Z (6 months ago)
- Last Synced: 2024-09-26T13:43:19.596Z (about 18 hours ago)
- Topics: frc, frc-java, frc-library, gradle, jitpack, math, robot, robotics
- Language: Java
- Homepage: https://stuypulse.github.io/StuyLib/
- Size: 8.69 MB
- Stars: 31
- Watchers: 30
- Forks: 7
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://jitpack.io/#StuyPulse/StuyLib)
[](https://github.com/StuyPulse/StuyLib/actions/workflows/build.yml)
---
# What is StuyLib?
StuyLib is an FRC library / toolkit which includes many different utilities for programming. It includes things like a Gamepad Library, a Limelight Library, a Digitial Filter / Streams Library, and many other utilities relating to math and programming.
# Awards
- IStreams / IStreamFilters:
- [Innovation in Control Award sponsored by Rockwell Automation](https://www.thebluealliance.com/event/2020scmb#awards)
- Limelight + Encoder Fusion / Drive Filters:
- [Innovation in Control Award](https://www.thebluealliance.com/event/2022nyro#awards)
- Clean & Concise Code / Smart Network Library:
- [Innovation in Control Award](https://www.thebluealliance.com/event/2022nyli2#awards)
- Usage of Encoders / Limelight + Encoder Fusion:
- [Innovation in Control Award](https://www.thebluealliance.com/event/2022nyny#awards)
# How do I use StuyLib?
### Setting up StuyLib
[Instructions from JitPack.io](https://jitpack.io/#StuyPulse/StuyLib)
Step 0. This is done by default for robot projects, but if your doing a local project you must remember to include this at the top
```groovy
plugins {
id "java"
// You can use different versions of GradleRIO between your robot
// code and Stuylib as long as the updates don't break anything
id "edu.wpi.first.GradleRIO" version "2020.2.2"
}
```
Step 1. Add the JitPack repository to your `build.gradle`
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
- Step 2. Add the dependency to `build.gradle`
[](https://jitpack.io/#StuyPulse/StuyLib)
```groovy
dependencies {
// check tag above for most recent version
compile 'com.github.StuyPulse:StuyLib:VERSION'
}
```
### Other Dependencies
If you want the NetworkTable classes to work on something other than the robot, then you need to include other dependencies.
If you are using network tables anywhere else than the robot, ie. on a laptop, you will need to include the jar files in the `./lib` folder. For example, when using NetKeyboard, you need to run a program to send the keyboard input, [here is the program](https://github.com/Sam-Belliveau/NetworkKeyboardServer). This program uses these jar files to send network table data to the robot. It is otherwise pretty rare that you would need to use these
# Criteria for Code Contribution
When contributing code, as always, make a branch and a pull request.
All code MUST be commented, and no single class should be too complicated.
At the top of each class, give a brief description of the class, along with an author tag which contains an email just in case anybody has any questions on how to use it.
# Star History
[](https://star-history.com/#StuyPulse/StuyLib&Date)