FTCLib: A Java repository from 1198159

Logo produced by Xing from FTC Team 15303

Origin: https://github.com/FTCLib/FTCLib

Upstream: https://github.com/OpenFTC/OpenRC-Turbo

Project led by Jackson Isenberg and the Alpharetta Robotics Club

WARNING THIS LIBRARY IS CURRENTLY HIGHLY SUBJECT TO CHANGE

FTCLib is a library designed to be the only library you'll need for FTC programming. The project was initially meant to be a port of WPILib, which is the standard programming library for FRC that almost all teams use. However, with FTC, there are a ton of libraries that not many people have heard about, especially rookie teams who are just starting. The goal of FTCLib is to improve the initial programming experience for new members as well as greatly enhance the efficiency of code for veterans.

Please read the documentation and the rest of the README before you get started with the library.

FTCLib documentation - https://ftclib.gitbook.io/ftclib

Welcome to FTCLib!

Thank you for using the FTCLib library for your code! All of the people who worked on it have put a lot of effort into making FTCLib an amazing library. We thank you for putting our effort to work with your own projects. We hope you have great luck and success with your programming.

The mission of FTCLib is briefly summarized in the following quote made by Jackson from ARC Robotics, who started the library.

Our goal is to make programming easier and more efficient through effective classes and detailed examples of implementation. - Jackson ARC Robotics

Why Use FTCLib?

FTCLib is a non-profit, open source, community-driven library created solely with the intent of helping rookie teams learn programming easier and maximizing efficiency for veteran teams. By putting everything into one library, with enough documentation to build a rigorous learning experience, all teams can benefit from using FTCLib. It's fast, easy, efficient, and powerful. The idea is that this truly is the last library you will ever need.

FTCLib still has the ability to be used along with other libraries without conflict. If you still want to use other libraries alongside ours, go ahead. FTCLib's purpose is solely to improve everyone's programming experience in FTC.

How to use developer release

Add this to your build.common.gradle:

    repositories {
        jcenter()
    }

Now, in your TeamCode buid.gradle, add these lines:

dependencies {
    implementation 'com.arcrobotics:ftclib:1.0.0' // Replace 1.0.0 with the latest release
}

To ensure the project builds correctly, please follow steps below:

Attention Users!

This library uses Java 8! If you do not already have Java 8 on your FTC Project, please do so! If you do not know how to, read further. Doing this will require all other devices to delete and then reclone the project following the change! You get weird Android Studio errors other wise. To change, go to the build.common.gradle and find the lines that say

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_7
        targetCompatibility JavaVersion.VERSION_1_7
    }

Change the 7 to an 8 and then perform a Gradle Sync. You now have Java 8 (and all the things that come with it)!

Installation

Open up your FTC SDK Project in Android Studio.
Go to your build.common.gradle file in your project.
Add the following to the repositories section at the bottom of the file.
```
jcenter()
```
Open the build.gradle file in your TeamCode module.

Go to the bottom of the file, and add the following.

dependencies {
    implementation 'com.arcrobotics:ftclib:1.0.0'
}

Because FTCLib makes use of advanced features, you need to increase the minSdkVersion to 24. Unfortunately, this means that ZTE Speed Phones are not supported in this release.

In build.common.gradle, change the minSdkVersion from 19 to 24:

    defaultConfig {
        applicationId 'com.qualcomm.ftcrobotcontroller'
        minSdkVersion 24
        targetSdkVersion 26

Perform a gradle sync to implement your changes.

NOTE: If your module has a few dependencies, you might have an error related to multidex on building the project. This is caused by the project exceeding the limit for imports enforced by Android Studio. To solve this, add multiDexEnabled true to the below location inside the build.common.gradle file.

    defaultConfig {
        applicationId 'com.qualcomm.ftcrobotcontroller'
        minSdkVersion 24
        targetSdkVersion 26


        multiDexEnabled true

Legality for competition use

FTCLib is currently in full version 1.0.0. Our library is cloned from OpenRC-Turbo. Please take a look at the upstream for information regarding legal use, variants, and stock.

Contributing

Since this is a community-driven, open source library, we are constantly looking for more content. If you feel there is something missing from our library, feel free to contribute! If you want to contribute to the project, be sure to read the CONTRIBUTING.md.

Please make sure to contact us if you have any other questions.