Skip to main content

Mars-RS Documentation

A powerful WebAssembly-based robotics simulation and path planning tool for VEX competitions. Design autonomous routines, test movement algorithms, and visualize robot behavior in real-time.

Get StartedExplore API
Robot Control

Quick Start

Get Mars-RS running in minutes with these simple steps.

1

Clone the repository

Start by cloning the Mars-RS repository to your local machine:
git clone https://github.com/8pxl/mars-rs.git
cd mars-rs
2

Build the WebAssembly binary

Compile the Rust code to WebAssembly using Cargo:
cargo build --release --target wasm32-unknown-unknown
Make sure you have the wasm32-unknown-unknown target installed. Run rustup target add wasm32-unknown-unknown if needed.
3

Serve the application

Open index.html in a local web server. You can use Python’s built-in server:
python -m http.server 8000
Then navigate to http://localhost:8000 in your browser.
4

Start simulating

Use the interface to switch between Driver mode, Autonomous mode, and Path Creation mode. Press T to toggle between modes.
You should see:
  • A purple checkered VEX field
  • A red robot that you can control
  • Mode indicators showing “driver”, “auton”, or “create”
  • Buttons for switching modes

Key Features

Everything you need to plan and test autonomous robot routines.

Advanced Movement Algorithms

PID control, Pure Pursuit path following, and Boomerang motion for smooth, accurate robot movement.

Interactive Path Editor

Draw, edit, and save autonomous paths with a visual interface. Test paths instantly in simulation.

Real-Time Simulation

Watch your robot execute paths with accurate physics simulation and field visualization.

Driver Control

Test manual control with WASD keyboard input. Perfect for hybrid autonomous routines.

VEX Field Rendering

Accurate VEX Robotics competition field with game elements, goals, and load zones.

WebAssembly Performance

Runs at native speed in any modern browser thanks to Rust and WebAssembly.

Explore by Topic

Deep dive into the concepts and APIs that power Mars-RS.

PID Control

Learn how proportional-integral-derivative controllers enable precise robot positioning and smooth movement profiles.

Read more

Pure Pursuit Algorithm

Discover how Pure Pursuit path following creates smooth trajectories by targeting lookahead points along your path.

Read more

Robot API

Explore the Robot struct that manages position, heading, rendering, and motion with differential drive kinematics.

View API

Movement Functions

Reference for all movement algorithms including pidMTP, boomerang, followPath, and Pure Pursuit implementations.

View API

Ready to simulate?

Start building and testing autonomous routines for your VEX robot. Mars-RS makes path planning intuitive and accurate.

Get Started Now