Files
aego/engine/res/docs/quickstart.md
sanspie 2e10968d48 Stage 11f3: landing, Getting started, guides; demo fixes (D347, D289)
Landing page and Install Aego / Your first project in English and Russian; the 2D template matches them. Platformer from scratch and Recipes with every step scene run by docs check. Builtin data and handle methods in the reference, Inspector names in field tables, Markdown copies and llms-full.txt, strict docs check in CI, engine/docs/README.md.
Fixes: a body cast from a touching contact uses the face normal, so characters no longer stick after a respawn or against walls; Respawn.resetVelocity works; a touch gamepad on exported web pages.
2026-10-25 15:31:22 +03:00

2.7 KiB

id, icon, group, title, order, style_allow
id icon group title order style_allow
quickstart play.start start Your first project 1
agent

Your first project

Ten minutes from an empty folder to a sprite you control, exported to a folder you can send to a friend.

1. Create a project

Open Aego. Click New Project, pick 2D, name it hello, choose where it lives and click Create. The editor opens the project's main scene: a camera and a sprite.

2. Look around

Hierarchy on the left lists the scene's nodes. The Inspector on the right shows the selected node's components and their fields. The middle is the Scene view — drag to pan, scroll to zoom, click a node to select it. Press Play (or Ctrl+P): the Game view shows what a player sees. Press Stop to return.

3. Make it move

In Assets, right-click the scripts/game folder and choose New → Script…. Name it Spinner and click Create. The script editor opens with an empty script; give it an Update:

package game

script Spinner {
	func Update(dt float) {
		node.SetRotation(node.Rotation() + dt)
	}
}

Save (Ctrl+S). Select the sprite, click Add Component in the Inspector, type spinner and choose Spinner. Press Play: the sprite turns. Change dt to dt * 3 while the game runs and save — it spins faster without restarting. That's hot reload; it works for every script.

4. Add control

Replace the script with input:

package game

import "aego/input"

script Spinner {
	func Update(dt float) {
		p := node.Position()
		p.X += input.Axis("Move") * 5 * dt
		node.SetPosition(p)
	}
}

Move is an input action — the arrows and A/D by default, a gamepad stick if one is plugged in. Actions are defined in Project Settings → Input; add your own there.

5. Rewind it

While playing, press F6 to pause and drag the timeline at the bottom of the Game view. The game runs backwards to the frame you choose and forwards again — every frame, exactly as it happened. Press F7 to step one fixed tick.

6. Export it

File → Export… opens the Export panel. Pick Web as the target, choose an output folder and click Export. Click Run: the panel serves the folder locally and your game opens in the browser. Pick Linux, Windows or macOS for a native build; a system other than your own needs Go and the engine source, see Install Aego.

Where to go next