Coding

From RoboCo
Jump to navigation Jump to search
Microcontroller Interface

⚙ Getting Started[edit]

Programming is complex, especially when you don't know where to start. For those without access to programming classes or extracurriculars via their learning institution, RoboCo recommends CodeAcademy's Learning Python. This course is a great way to learn the fundamentals of Python AND is fully virtual, so players can take classes whenver they want.

In addition to learning the language, players will also need a program to code in. RoboCo recommends Visual Studio Code and its accompanying Python extension. This is the program RoboCo developers use to write code for RoboCo. It comes with a variety of different customization options and extensions to fit all your coding needs (including Java and C++). You can also try Notepad++ and Sublime if Visual Studio Code is of little interest or isn't avaliable.

Additionally, RoboCo requires players to use its custom API Documentation. This is the way in which players "talk" to their robots and includes instructions for how to program the different sensors and other controllable parts within the game. Players can access the API here or by clicking the API button in the Microcontroller interface within RoboCo.

Back to Top

⚙ Current Available Sensors[edit]

Sensors are programmable parts that allow a robot to interpret the physical world into processable data. Think of them as the robot equivalent to a human's eyes or ears. The robot can be instructed via code to take actions based on the sensor data it receives, which is what allows a robot to complete tasks on its own (like delivering a sandwich across a crowded restaurant or launching a soda can across a room).

Below is a list of all the sensors currently available in the game. Other parts that can be controlled with Python can be found on the Controls page.

Name Icon Description
Touch Sensor Touch Sensor Icon 2.png A part that sense touch input.
Force Sensor Force Sensor.png A part that senses the forces applied to it along 6 axes.
Inertial Sensor / IMU Inertial Motion Sensor Icon.png A sensor for measuring acceleration, rotation, and angular velocity.
Distance Sensor Distance Sensor.png A part that senses the distance to the first object it encounters.
Color Sensor Color Sensor Icon.png A camera that senses the color in front of it.

Back to Top

⚙ How to Load a New or Completed Script[edit]

RoboCo Code Preview

The first step to accessing the programming interface in RoboCo is attaching the microcontroller to a robot. This is the "brain" of a robot, and this can be found in the Powered section of the Parts inventory.

Once players have added as microcontroller to their robot, they can either hit the "New" button to create a new script or the "Load" button to upload a previous or already completed script from their desktop. Currently, all scripts for RoboCo live in a folder called "Scripts" which players can access via the "Open Script Folder" button or by going to This PC --> Documents --> my games --> RoboCo --> (Your Steam Username) --> Scripts.

Once players have loaded in their code correctly, they'll see a preview of it in the microcontroller interface.

Back to Top

⚙ How to Assign Ports[edit]

RoboCo has two options when assigning ports: manual or automatic. If players want to automatically map their ports, simply click the auto-assign button in the microcontroller interface. If they want to manually map their ports, follow the instructions below:

Step Description Example
Assinging Ports Example.png
Step 4 Press the play button (or spacebar) to run the code. If an error occurs, use the in-game debug console to help troubleshoot. RoboCo Debug Console Example.png

Back to Top

⚙ Importing External Scripts[edit]

The RoboCo python interpreter searches a few places for libraries by default. The main location is <your steam directory>\steamapps\common\RoboCo\RoboCo_Data\StreamingAssets\Robocode\python\Lib. The game's code libraries are stored here.

Adding a file to the Lib directory will allow you to import it from any script in your robots, however the Lib folder could get reset in the future, and it's inconvenient to set up libraries in the folder over the Scripts folder where the scripts for all of your robots (including ones from the workshop) are stored.

The Scripts folder is located far within the user's Documents folder, and is not searched for libraries by default. The following code segment adds the Scripts folder to the list of folders to look for libraries in.

import os, sys
path = str(os.path.expanduser('~'))+'\\Documents\\My Games\\Roboco'
if not os.path.isdir(path): path = str(os.path.expanduser('~'))+'\\My Documents\\My Games\\Roboco'
if os.path.isdir(path):
    for file_path in os.listdir(path):
        for folder in os.listdir(os.path.join(path, file_path)):
            f_path = os.path.join(path, file_path, folder)
            if(os.path.isdir(f_path) and folder == 'Scripts'):
                if not (f_path in sys.path): sys.path.append(f_path)
else:
    print('*Error finding Roboco folder*')

After the path is added, the files within the Scripts folder can be imported like any other file would be.

Importing a script from another known directory is simple, too.

For example, on my computer (your steam directory might be different), this code will allow me import a file from the RoboCo game folder.

import sys
sys.path.append('C:\Program Files (x86)\Steam\steamapps\common\RoboCo')

Back to Top

⚙ Troubleshooting[edit]

RoboCo has a debug console built into its coding interface that allows players to see what lines of code are causing errors. This should be the first step in helping troubleshoot Python code.

If players encounter a more complicated situation, there is a #coding-and-automation-help-desk channel in the Official RoboCo Discord, which is meant to help troubleshoot more complicated behaviors. Once players have submitted a question to the channel, a member of RoboCo's dev team or equally knowledgeable Discord member should respond with guidance on how to solve the problem.

Back to Top