Skip to content

nab138/GearGlimpseRevolution

Repository files navigation

GearGlimpse Revolution

Build GearGlimpseRevolution

FRC AR Tools for iOS!

Powered by theos

Installation

To install on an iDevice, you can use the altstore/sidestore source linked above for easy installation. Alternativley, you can download the ipa from the latest release or actions run for the bleeding edge.

You can use sideloaders such as sidestore, sideloader, altstore, etc to install the ipa.

Usage

Tap on a plane to place the field, pinch and twist to scale and rotate. You may have to move the phone around a bit before the field will be placeable.

To connect the app to networktables, press and hold to open the configuration menu.

To import a custom robot, convert it to a .usdz file, then you can import it from the configuration menu.

Development

  1. Follow the installation guide from theos (doesn't matter what toolchain you pick, you will be replacing it anyways)
  2. Download the correct swift toolchain (note that theos's default swift toolchain will not work for this project). Yes, that is the correct link on windows as well. Extract it to $THEOS/toolchain (make sure $THEOS/toolchain is empty before extracting, delete any files in there if necessary)
  3. Follow these instructions or theos will not build the app correctly.
  4. Download the required frameworks and extract them into $THEOS/lib
  5. Clone the repo, git clone https://github.com/nab138/GearGlimpseRevolution && cd GearGlimpseRevolution
  6. Download the required assets and place them in the "Resources" folder
  7. Run make package to build an ipa

If you add the sideloader cli to $THEOS/bin, you can run deploy.sh to automatically build and install to your ios device.

Current Features

  • Basic field placement
  • Field Scaling & Rotation
  • Transparent/Invisible Field
  • Networktables support for robot position (Sim or real robot)
  • Robot switching
  • Custom robot import
  • Built-in configuration options (long press to access)
  • AprilTag Detector (unstable, and doesn't do anything right now
  • Command Scheduler Display
  • FMS state info display (enabled, mode, alliance, etc)
  • Trajectory Rendering

In progress features

Features that are being worked on. Features with a checkmark are in a working state, but aren't included in the latest release yet and may not be stable.

  • Alignment with real field via AprilTags

Planned Features (in no particular order)

  • Field Switcher
  • Field Element Placement
  • Mechanism Rendering (maybe)

Credits

Theos does not currently support installing spm packages/pods, so the following libraries are part of the source tree but were NOT written by me: