VRC-RoboScout

An iOS application to automate the scouting process for the VEX Robotics Competition.

Contributions are being accepted

Contributors will have to sign a CLA as VRC RoboScout is a published iOS application.

Building from source for testing

Testing is strongly encouraged and incredibly valuable during this stage of development. Please feel free to do so and give feedback on the development Discord server.

Below are the steps you must follow:

1. Download Xcode. You can do this from the MacOS App Store.
2. On the main repository page, select Open with Xcode in the Code menu (see image below).

3. Select a destination for the project to be cloned on your computer. Trust and Open the project when prompted.
4. Wait for Xcode to load the project. You have successfully cloned VRC RoboScout to your computer!
5. You will now generate your own RobotEvents token to allow VRC RoboScout to interact with the RobotEvents API. To do this, first head over to the RobotEvents API homepage here.
6. In the Request Access page, fill out the form and request access (see image below).

7. Requests are approved instantly. Next, select the new Access Tokens page where the Request Access page previously was (see image below).

8. Press the Create New Token button. Name your token VRC RoboScout, and press Create (see image below).

9. Copy your token now. You will not be able to see it again and will have to generate a new one if you lose it (see image below).

10. In Xcode, press Product on the menu bar at the top of your screen. Then press Scheme, then Edit Scheme... (see image below).

11. Select Run on the left menu bar. In the Environment Variables section, press the + icon to create a new environment variable. You MUST name it ROBOTEVENTS_API_KEY, or else the app will not work! Paste your token in the Value area.

12. Select a build target at the top bar (see image below) to choose the simulator or physical device you wish to run VRC RoboScout on! The default is the latest iPhone simulator, but you may run VRC RoboScout on any iPhone or iPad on iOS or iPadOS 16 or greater.

13. [OPTIONAL] If you wish to build to a physical device, such as your iPhone or iPad, you will need to follow additional steps such as enabling developer mode and trusting the computer on your device. A guide on enabling developer mode for your iOS device can be found on the Apple developer website.
14. You are now ready to build and install VRC RoboScout! With your device or simulator selected, press the play button (see below) to build, install, and run VRC RoboScout! If you are running it on your physical device, you will need to trust the developer profile before being able to open the app. A guide for that can be found here.

15. [OPTIONAL] Please join the VRC RoboScout Discord server here to share your feedback! You are now also eligible to become a beta tester for VRC RoboScout. Please ping a developer in the server for the Beta Testers role and access to beta testing channels if you are interested!