Skip to main content

API Docs Introduction

Welcome to the Simulo API Docs!

Getting Started​

The first thing you need to do is add the simulo executable to your PATH environment variable. This will allow you to run Simulo from the command line, which you'll need for certain tasks.

You first need to find the folder where Simulo is installed. Go into Steam, right-click on Simulo in your library, and select Properties. Then, go to the Installed Files* tab and click on Browse. Take note of this folder path.

Adding Simulo to PATH on Windows​

  1. Open the Start Menu and search for "Environment Variables".
  2. Click on "Edit the system environment variables".
  3. In the System Properties window, click on the "Environment Variables" button.
  4. In the Environment Variables window, find the "Path" variable in the "System variables" section and select it.
  5. Click on the "Edit" button.
  6. In the Edit Environment Variable window, click on the "New" button and add the path to the folder where simulo.exe is located.
  7. Click "OK" to close all windows.

Now, you can open a new Terminal/Command Prompt/Powershell window and you'll have the simulo command available.

Using Simulo CLI​

Now what you can do is navigate to the Simulo Sandbox2D folder in a new terminal. Make sure you only opened it after adding Simulo to your PATH, otherwise it won't recognize the command.

Start by finding Sandbox2D. On Windows this should be in C:\Users\<your username>\AppData\Local\simulo\packages\@Carroted\Sandbox2D, and on Linux it's ~/.cache/simulo/packages/@Carroted/Sandbox2D``. You can navigate there using the cd` command. For example:

cd C:\Users\<your username>\AppData\Local\simulo\packages\@Carroted\Sandbox2D

Now run this to set it up:

simulo i

Finally, you can run Sandbox2D with:

simulo run

This should open Sandbox2D!

Next Steps​

From here, you can open that Sandbox2D folder in VSCode. You can now start modifying the game!

After making changes, simply re-run simulo run in the terminal. You don't need to run simulo i again.

Future Plans​

In the future we'll allow doing all of this in-game and simplify the process. We're still working on things, but for now this is the best way to start modding Simulo.