Manual
Manual
The editor's windows
A tour of the editor: where its panels are, what each is for, the shortcuts that open them, how to play your game and move around the Scene view, where the settings windows are, and how to reach this manual from the editor.
The default layout
| Where | Panels |
|---|---|
| Left | Hierarchy |
| Middle | Scene and Game, as tabs, Scene in front |
| Right, the full height | Inspector |
| Along the bottom, under the Hierarchy and the Scene | Project, Logs, Audio and Animator, as tabs, Project in front |
The other panels start closed, and open from the Window menu or as you open what they edit.
Drag a panel's tab to dock it somewhere else, or out of the editor into a window of its own. The button on a tab closes the panel, and the Window menu brings it back. Window ▸ Reset Layout puts the default layout back. The editor opens as you closed it, panels and settings windows included. The line along the bottom says what it is busy with, such as files importing or a build.
The menus
| Menu | What is in it |
|---|---|
| File | New Scene, Open Scene, Save Scene, Save Scene As, Build Settings, Refresh (builds your scripts again), Quit |
| Edit | Undo and Redo; Cut, Copy, Paste, Rename, Duplicate, Delete and Select All, for whatever is picked; Play, Pause and Step; Preferences; Project Settings |
| Entity | Create Empty, Create Empty Child, and menus of what to make: 3D Object, 2D Object, Light, Audio, Effects, UI and Camera |
| Tools | Commands your game's code and its packages add |
| Window | Every panel, Addressables, Package Manager, windows packages add, and Reset Layout |
| Help | Manual (F1) and Scripting API, which open this manual at the editor's version; About, with the versions the editor runs on |
The Play controls are in the middle of the menu bar, and Sign In is at its right end (see Sign in).
The manual from the editor
Help ▸ Manual and Help ▸ Scripting API open this manual at the version of your editor. In the Inspector, the ? at the right end of a component's header opens the component's page, and F1 opens the page of whatever the pointer is over: a component, a panel or a window. A built-in component without a page of its own yet opens the page on components.
A component of your own has a ? once it names a page, either a whole address or a path in this manual (see Declaring a component). A component of an official package without a page of its own opens its page in the Scripting API.
Play, Pause and Step
| Button | Shortcut | What it does |
|---|---|---|
| Play | Ctrl+P | Plays the game in the Game panel. Pressed again, stops it and puts the scene back as it was. |
| Pause | Ctrl+Shift+P | Holds the playing game on one frame. |
| Step | Ctrl+Alt+P | Moves a paused game on by one frame. Pressed while editing, starts the game held on its first frame. |
While the game plays, the editor is tinted dark orange, as a reminder that changes made then do not last.
The panels
Scene
Your view of the scene, through the editor's own camera. Click something to pick it, or drag a rectangle to pick everything in it. The row along the top holds the Move, Rotate, Scale and Rect tools, where the handle sits and how it turns, the magnet for snapping, and how the scene is drawn: 2D Lights, Grid, Bones, 2D and the draw modes. The gizmo in the top-right corner shows which way the view faces. See The Scene view.
Game
The game, through the cameras in its scene. The row along the top picks the size the game is drawn at (Automatic, or a screen size), and holds Maximize on Play, Record for a video (Shift+F12), a screenshot button (F12) and Mute Audio. See The Game view.
Hierarchy
The entities of each open scene as a tree, under a band with the scene's name. Drag a row onto another to put it under that one. Right-click, or click +, for a menu of what to make. F2 renames, Ctrl+D duplicates and Delete deletes. The search box finds entities by name, or by component with t:, as in t:Light. An instance of a prefab is written in teal. See The Hierarchy.
Inspector
What is picked. For an entity, an active checkbox, a visibility eye and its name, then a section for each component, its ? opening the component's page, and Add Component at the bottom. With several entities picked, an edit changes all of them. For a file picked in the Project panel, the Inspector shows its import settings, with Apply and Revert. See The Inspector.
Project
Your project's files: a tree of folders on the left, and the open folder's contents on the right, as tiles or a list. Its top folders are assets, shaders and scripts, and rust once it holds a file. Drag files in from your file manager to copy them into the open folder. Double-click a scene to open it, or a script to open it in your code editor. Click +, or right-click, for what you can make in the folder, such as a folder, a script or a scene. See The Project panel.
Logs
Messages from the editor, the engine and your code. Clear is on the left, and the Info, Warning and Error filters on the right, each with its count. Click a line to see all of it.
Other panels
| Panel | What it is for |
|---|---|
| Audio | The game's audio buses as a mixer's strips: a fader and meters for each, Solo and Mute, and its effects |
| Animator | The animator controller of the picked entity, its states as rows; while the game plays, it lights the state playing |
| Animation | Animation clips on a timeline of keys, with Curves for a graph of them and, for a UI element's clip, Record to key what you change; see Animation clips |
| Sprite Editor | Cutting an image into sprites, by a grid or automatically; the Sprite Editor button in an image's Inspector opens it |
| Tile Palette | The tile set of the picked Tilemap, to pick the brush you paint with |
| Style Sheets | The rules of the style sheets a UI document uses |
| Profiler | Where each frame's time goes, recorded while it is open and its Record is on; see The Profiler |
Packages can add windows of their own, in the Window menu under the package's name. The Navigation package adds Window ▸ Navigation ▸ Navigation, which lists the navmesh surfaces and bakes them.
Shortcuts that open panels
| Panel | Shortcut |
|---|---|
| Scene | Ctrl+1 |
| Game | Ctrl+2 |
| Inspector | Ctrl+3 |
| Hierarchy | Ctrl+4 |
| Project | Ctrl+5 |
| Animation | Ctrl+6 |
| Sprite Editor | Ctrl+7 |
| Audio | Ctrl+8 |
| Animator | Ctrl+9 |
| Logs | Ctrl+Shift+C |
Style Sheets, Tile Palette and Profiler have no shortcut; open them from the Window menu.
Moving around the Scene view
| Do this in the Scene view | To |
|---|---|
| Hold the right mouse button | Fly: the mouse turns the camera, W, A, S and D move it, E goes up and Q down, Shift goes five times faster, and the wheel changes the speed |
| Alt and drag with the left button | Orbit round the pivot |
| Drag with the middle button | Pan |
| Alt and drag with the right button | Zoom in and out |
| Turn the wheel | Zoom toward the pivot, or toward the pointer with Alt |
| Arrow keys | Move the camera, while the Scene panel has the keyboard |
| F | Frame what is picked |
| 2 | Switch the 2D view on or off |
| Keypad 5 | Switch between perspective and orthographic |
The tools have keys too: W for Move, E for Rotate, R for Scale and T for Rect. Hold Ctrl while dragging a handle to snap it. See The Scene view for the 2D view, the corner gizmo and snapping.
Settings windows
| Window | Where | What it holds |
|---|---|---|
| Project Settings | Edit ▸ Project Settings… | The game's settings, by page: Player, Input, Tags and Layers, Time, UI, Localization, Add-ons, and pages your code and packages add. Saved in settings/, for everyone on the project; the Add-ons page's Test Server is kept on your computer only. |
| Preferences | Edit ▸ Preferences… | Your own settings: where the package registry is, and where screenshots and videos go. |
| Build Settings | File ▸ Build Settings… (Ctrl+Shift+B) | The scenes in the build, the platform, and Build. See Build and run your game. |
| Package Manager | Window ▸ Package Manager | Packages from the Abyss Registry, your My Assets and the Store, to install, update and remove. |
| Addressables | Window ▸ Addressables | The assets your code loads by name, their groups, and Build Packs. See Assets, identities and addresses. |
On a Mac
The menus are in the macOS menu bar: Abyss Engine (About, Preferences… with ⌘, and Quit), then File, Edit, Entity, Tools, Window and Help, where macOS adds its search of the menus. Cmd takes the place of Ctrl in every shortcut. Redo is ⌘⇧Z, Delete is ⌘⌫, and Enter renames. F1 and F12 are fn+F1 and fn+F12 unless macOS is set to use the F keys as standard function keys.
