Skip to content
This repository has been archived by the owner on Aug 2, 2020. It is now read-only.

Cookiecutter template for a FRC robot using Third Coast in Java or Kotlin.

License

Notifications You must be signed in to change notification settings

strykeforce/cookiecutter-robot

Repository files navigation

Deprecated

This project is deprecated and no longer updated for FRC seasons past 2019. Use the WPILib new project creator installed by WPILib.

Original README

cookiecutter-robot

A cookiecutter template to create a new FRC robot project in Java or Kotlin. With the right hardware, this will produce a working swerve-drive robot.

See examples of usage in thirdcoast-examples repo and other resources at strykeforce.org.

Features

All features can be optionally enabled.

Note: Kotlin cookiecutters are not yet updated for 2019 season.

Hardware Assumptions

The template generates a robot project that assumes the following hardware is in use.

NOTE: Do not assume PID parameters will work for your hardware. You must test and tune as needed.

  • Third Coast Swerve Drive
  • Interlink X Flight Simulator driver controls on USB port 0 of Driver Station
  • Logitech F310 Game controls on USB port 1 of Driver Station

Quickstart

You must have Python and Pip installed. Install the latest Cookiecutter if you haven't yet:

pip install -U cookiecutter

Generate a FRC robot project:

cookiecutter gh:strykeforce/cookiecutter-robot

Then:

  • Format source code: ./gradlew spotlessApply (if Spotless code formatting enabled)
  • Build project: ./gradlew build
  • Deploy to robot: ./gradlew deploy

License

This project is licensed under the terms of the MIT License