A WIP, extremely agile competition assistant application for the VEX Robotics Competition, set to release in 2025 on iOS.
It is also the submission for Assessment Task 3 (2024 Major Work).
VRC Companion is still in development. No public releases are available at the moment.
Contributions are welcome. Please note that this codebase was initially written as a Year 12 Major Work project - expect some janky code and bad practices. Open a PR if you find some. For markers, be rest assured that no one apart from the student himself has contributed to this codebase prior to submission. You can verify this in the commit history.
If you are to fork the repository, please follow the license agreement.
Xcode is required to build/modify VRC Companion.
Note
Only Xcode 15 is officially supported. Xcode 16 has not been tested.
- Download Xcode from the App Store. Install all required toolchains if prompted.
- Follow Apple's guide to authenticate your GitHub account in Xcode.
- At the start menu, select "Clone Git Repository...".
- Clone this repository using the URL.
- Obtain and put your RobotEvents API token in
./VRC Companion/Models/NetworkRequests.swift, line 19. I acknowledge that this is very unsafe, and a better method is in the works. For now, please take caution to NEVER commit your token onto the repository. If you are an assessment marker, you do not need to request a token - one has already been provided to you in submitted documents.
Initiate a build for running using ⌘B.
It is recommended to test a full build on an iOS device. Alternatively, you can choose to run the project in a simulator.
To initiate a run, simply select your preferred device/simulator in the toolbar and press ⌘R.
If you have never done this before, please follow Apple's guide to set up your simulator and iOS device. It should take no more than 15 minutes.
VRC Companion was originally developed (with ♥︎) by fini7y, member of the 1051X Siege V5RC team.
The following projects/people have greatly impacted development. Without them, this project would not have existed.
A big thank-you to:
- VRC RoboScout by SunkenSplash, for the sparking of this idea.
- Matteo Manferdini, for tutorials, critical architectural insights, preview extensions, and the networking layer.
- Hacking with Swift, for tutorials on key concepts.