This article provides an overview of the process for creating VEX V5 projects in the VEX Visual Studio Code (VS Code) Extension. Projects in the VEX VS Code Extension can be created in two ways - by creating a new project from an example template or importing an existing VEXcode project.
Note: If this is your first time creating or importing projects in VS Code, you may need to enable additional permissions on your device for VS Code to work as intended.
Create a New Project in VS Code
Launch Visual Studio Code on the computer. Select the VEX icon on the VS Code Activity Bar.
If the VEX icon does not appear, ensure you have installed the VEX extension. For steps to install this extension, see the following article that matches your device.
Select the 'New Project' button under 'PROJECT ACTIONS' in the Primary Side Bar.
The Create a New VEX Project window will prompt. Select the V5 icon to select the Project Platform for the VEX V5 project.
Choose either Python or C/C++ as the programming language and select the corresponding icon.
Next, select a Template or Example Project for creating the VEX V5 project.
- Find the Template or Example Project by scrolling down or using the Search bar to filter the list of projects.
- These Template and Example Projects contain sample code and/or robot configurations used to get the project started.
After selecting a Template or Example Project, select 'Create.'
Next, set the Project Name, Description, and Location for the new project.
Type the name of the project in the text box under 'Project Name.'
Note: The project name will be used for the name of the top-level folder for the project. It also will be the name displayed on the V5 Brain's screen once the project has been downloaded to the robot.
Type the description of the project in the text box under 'Description.' This step is optional.
If you want to save the project in a different location than the default project folder, scroll down the window and select the 'Browse' button to choose the location for the project folder on the computer.
Note: The default project location is set to the default project folder found in the extension global settings.
Now that the Name, Description and Location have been entered, select the 'Create' button. The VS Code Window will begin refreshing.
The project for VEX V5 has now been created in the VEX VS Code Extension. To view and develop the project code, select 'src' under the project name in the Side Bar.
Select 'main.py' (if the project is a Python project) or 'main.cpp' (if the project is a C/C++ project) under 'src' in the Side Bar.
The code of the selected Template or Example Project will be shown in the Editor area, where you can develop and edit the created project for VEX V5.
Import an Existing VEXcode V5 Project
Launch Visual Studio Code on the computer. Select the VEX icon on the VS Code Activity Bar.
Select the 'Import Project' button under 'PROJECT ACTIONS' in the Primary Side Bar.
The Import Project window will open. Select the VEXcode V5 project file to import and click on the Open Button.
Note: The supported VEXcode project file types for VEX V5 are:
- .v5cpp (VEXcode V5 C/C++ project)
- .v5python ( VEXcode V5 Python project)
Next, set the Project Name, Description, and Location for the imported project.
By default, the name of the project will remain the same.
Type the description of the project in the text box under 'Description.' This step is optional.
If you want to save the project in a different location than the default project folder, scroll down the window and select the 'Browse' button to choose the location for the project folder on the computer.
Note: The default project location is set to the default project folder found in the extension global settings.
Now that the Name, Description and Location have been entered, select the 'Create' button. The VS Code Window will begin refreshing.
Once the VS Code window refresh is complete, the VEXcode V5 project has been imported into the VEX VS Code Extension. To view and develop the project code, select 'src' under the project name in the Side Bar.
Select 'main.py' (if the imported project is a Python project) or 'main.cpp' (if the imported project is a C/C++ project) under 'src' in the Side Bar.
The code of the imported project will be shown in the Editor area, where it can be modified.