Getting started

Your first project

In this page you’ll open the editor, make a project, put a cube in a scene and press Play. It takes about five minutes.

Open the editor

Otter doesn’t have a downloadable release yet, so for now it runs from the source:

git clone https://github.com/otterengine/otter
cd otter
cargo run -p otter-editor --release

Make a project

The editor opens on the project launcher.

  1. Click New Project.
  2. Pick an empty folder for it. Otter puts everything the project needs inside that folder.

The editor opens with an empty scene. Around the viewport in the middle are:

PanelWhat it’s for
HierarchyEvery object in the scene, as a tree.
InspectorThe selected object’s components and their properties.
AssetsThe files in your project: scenes, scripts, materials, models.
ConsoleMessages from the engine and from your scripts.

Add something to the scene

  1. Open the Scene menu and pick Cube.
  2. The cube appears in the viewport and in the Hierarchy, already selected.
  3. In the Inspector, find Transform and change Position to move it.

Add a light the same way, with Scene → Light, so the cube isn’t lit only by the sky.

Press Play

Click Play above the viewport. The scene runs: physics steps and scripts run their hooks. Click Stop to go back to editing. Anything that changed while playing goes back to how it was.

Nothing moves yet, because nothing has a script. That’s the next page.

Save

File → Save Scene saves the scene into your project’s assets folder. Scenes are files like any other asset, so a project can have as many as you want.