Manual
Manual
The Project panel
The Project panel shows your project's files: a tree of folders on the left, and the open folder's contents on the right. This page covers finding and picking files, opening them, making, renaming, moving, duplicating, copying and deleting them, bringing files in from your computer, dragging them into the scene, and their import settings. Open it with Window ▸ Project (Ctrl+5).
On a Mac, Cmd takes the place of Ctrl in every shortcut on this page.
The two columns
The left column is the tree of folders. Click a folder to open it on the right; click its arrow to fold or unfold it in the tree. Drag the line between the columns to make the tree wider or narrower.
Along the top of the panel:
- + opens the menu of what to make in the open folder (see Make files).
- The path of the open folder, a button for each folder on the way,
assets › models › props. Click one to go back up to it. - The search box, at the right end (see Search).
- When your game has packages, a switch at the left end shows a package's files in place of the project's (see Packages' files).
Along the bottom, a line names what is picked, with Open where it opens and what it is, such as a model: opens on its own to be looked at. At its right end, the Size slider sets how big the tiles are; all the way to the left, the contents are a list, one row a file.
The top folders
| Folder | What it holds |
|---|---|
assets | What the engine loads: scenes, prefabs, images, models, sounds, materials, UI documents and the rest. See The assets folder. |
shaders | Your shaders, in WESL. |
scripts | Your game's C#. See C# in a game. |
rust | Your game's Rust, shown once there is a file in it. See Rust in a game. |
web | The scripts of a web build's page, shown when the folder is there. See JavaScript in a web game. |
The panel never lists the sidecar beside each asset, the .abyss file that holds its identity and import settings (see Sidecars and identities), nor the folders outside these, such as settings and cache. A file the editor does nothing with is listed faint.
Files
A file is shown by its name without its extension, pyramid for pyramid.gltf, with an icon for its kind. Folders, prefabs and the files you write have a color of their own:
| Kind | Shown as |
|---|---|
| Folder | A folder, in amber |
| Prefab | A cube, in teal; a variant is a cube with a frame round it |
| Model | A cube |
| Image | A picture of itself |
| Scene | A film slate |
| Material | A sphere, in sky blue |
| C# script | A C# file, in green |
| Shader | A code file, in violet |
| Sound clip | A sound file, in coral |
| Animator controller | A running figure, in rose |
| Animation clip | A film strip, in orange |
| UI document | A window, in lime |
| Style sheet | A CSS file, in blue |
| Rust | A Rust file, in orange |
| Web script | A JavaScript file, in yellow |
| Data asset | A blueprint, in saffron |
| Font | Two letters |
An image's tile is a picture of it. A small image, 128 pixels or less each way, is drawn enlarged by whole pixels, so pixel art stays sharp. A turning ring on a tile means the file is being imported.
An image cut into slices, and a model, have an arrow on their tile. Click it to show the slices, or the model's parts, beside the file: each mesh, each material, each clip, and its Skeleton if it has one. Each can be dragged as the whole file is; see Sprites and Models.
Rest the pointer on a file to see its path and what it is.
Pick files
Click a file or a folder to pick it, and the Inspector shows it.
| Do this | To |
|---|---|
| Ctrl+click | Add a file or a folder to what is picked, or take it away |
| Shift+click | Add everything shown between it and the one clicked last |
| Ctrl+A | Pick everything shown |
| Click empty space | Let go of everything |
| Drag from empty space | Pick everything a rectangle touches, as you drag |
| Right-click | Pick it and open its menu; on something picked already, keep everything picked |
With the rectangle, Shift adds what it touches, Ctrl turns each one over, and Escape puts back what was picked. Past the top or the bottom of the panel, the contents scroll toward the pointer, and what scrolls out of sight stays in the rectangle.
What is picked is dragged, duplicated, copied, cut, pasted and deleted together. One is renamed at a time.
Open files
Double-click a file, or pick it and click Open:
| File | Opens |
|---|---|
| Folder | In the panel |
| Scene | In place of the open scene, asking first about unsaved changes |
| Prefab | On its own, to edit; see Edit a prefab on its own |
| Model | Its prefab on its own, to look at |
| UI document | On its own, to edit; see UI documents |
| Animator controller | In the Animator panel |
| Animation clip | In the Animation window; see Animation clips |
| Slice | In the Sprite Editor, at that slice |
| Script, shader, style sheet, Rust | In the program your computer opens that kind of file with |
| Image, sound, text | In your computer's own program for it |
Scenes, prefabs and models do not open while the game plays. A script opens in whatever program your system has for .cs files; on Windows with none, it asks you to pick one.
Make files
+, or New in the menu of a right-click, makes something in the open folder. A right-click on a folder in the tree makes it in that folder.
| Item | What it makes |
|---|---|
| Folder | New Folder |
| Component Script | NewComponent.cs, a component of that name, in scripts |
| Lit Shader, Unlit Shader, UI Shader | NewLitShader.wesl, NewUnlitShader.wesl or NewUiShader.wesl, in shaders |
| Scene | NewScene.scene, with a Main Camera and a Directional Light |
| Material | NewMaterial.mat, a plain white surface |
| Animator Controller | NewController.controller, with one layer and no states |
| Animation Clip | NewAnimation.anim, empty, 12 frames a second, looping |
| UI Document | NewUIDocument.ui, with a style sheet of the same name beside it |
| Style Sheet | NewStyleSheet.css |
| Data assets | A file of each kind your code and packages declare, in submenus, such as Physics 2D ▸ Physics Material 2D (see Data assets declared in code) |
| Web Script | NewWebScript.js, in web |
| Rust Crate | The game's crate, rust/Cargo.toml and rust/src/lib.rs with one plugin, named after the game; see Rust in a game |
Scenes, materials, controllers, clips, UI documents, style sheets and data assets are made under assets, scripts under scripts and shaders under shaders; elsewhere the item is grayed and says why. A name taken already gets a number: NewScene1.scene. What is made is picked, with its name ready to type over, so you name it as you make it. A scene made here is not opened; double-click it to open it.
New scripts
Component Script makes NewComponent.cs in the open folder of scripts, with its name ready to type. Type the component's name, such as Health, and the file and the component in it are both named Health:
using System.Runtime.InteropServices;using Abyss.Core;
namespace MyGame;
/// <summary>A component of the game's own, which an entity can carry.</summary>/// <remarks>/// Each field is shown in the inspector and kept in a scene, and a system a plugin adds reads/// and writes it while the game plays./// </remarks>[AbyssComponent][StructLayout(LayoutKind.Sequential)]public partial struct Health{ /// <summary>A number it holds.</summary> public float Value;}The namespace is your game's, or the package's when you make it in a package's scripts. The editor builds the scripts at once, and the new component is in Add Component. See Declaring a component.
Rename
Press F2 (Enter on a Mac), or choose Rename in the menu. A box takes the place of the name, without its extension. Enter, or a click elsewhere, renames it; Escape keeps the old name. The extension stays unless you type another: brick and brick.png both rename a PNG to brick.png. The file's sidecar goes with it, so it keeps its identity, and every scene and reference that names it still finds it.
The top folders cannot be renamed, nor a slice, which is renamed in the Sprite Editor, nor a model's part.
Renaming a script renames its component. When the file declares one component named as the file, renaming Wobble.cs to Bob.cs renames the struct in all of your game's C#, and every scene and prefab that holds a Wobble, so each keeps its values. Then the scripts are built. The status line says how far it has got. A component whose [AbyssComponent(Name = ...)] gives it another name keeps that name in scenes.
Move
Drag files and folders onto a folder, in the contents, in the tree or on the path along the top, to move them there. A folder lights up where the drop can go. Each file takes its sidecar with it, and a folder everything in it. Nothing moves from one top folder into another, or between the project and a package, and a name the folder has already is refused.
The open scene follows its file, so Ctrl+S writes it to its new place.
Duplicate, copy and paste
| Item | Key | What it does |
|---|---|---|
| Duplicate | Ctrl+D | Copies what is picked beside itself, with a number after its name, pyramid 1.gltf, and picks the copy |
| Copy | Ctrl+C | Holds what is picked, to paste as often as you like |
| Cut | Ctrl+X | Holds what is picked, drawn at half strength, to be moved by the next paste |
| Paste | Ctrl+V | Puts a copy of what is held, or what was cut, into the open folder |
Escape lets go of what is held. What the Project panel copies stays in the editor; it is not put on your computer's clipboard.
Every copy is a new asset. Its sidecar keeps the original's import settings under an identity of its own, so a scene that names the original still names the original (see Moving, renaming and copying). A copy is not addressable until you tick it.
A script's copy declares a component of its own name: a copy of Drift.cs is Drift1.cs, declaring Drift1, and the editor builds it at once. Anything else the script declares, such as a plugin, its copy declares again, and the editor warns about it.
Delete
Delete (Cmd+Backspace on a Mac), or Delete in the menu, asks first: Delete rock?, saying what a folder holds. Delete (Enter) puts what is picked in the Recycle Bin, or the Trash on macOS and Linux, each file with its sidecar, where you can put it back from. Cancel (Escape) keeps it.
Ctrl+Z does not take back a change to files, whether a move, a rename, a copy or a delete. A deleted file comes back from the Recycle Bin or the Trash, with its sidecar, and keeps its identity.
Bring files in from your computer
Drag files or folders from your file manager onto the editor to copy them into the open folder. The Project panel comes forward, opened if it was closed, and says where they will go: Drop to copy brick.png into assets/textures. The originals stay where they were. A name the folder has already gets a number. The first file copied is picked, and the editor imports what it can read.
Drag files out of the panel
| Onto | A file does |
|---|---|
| The Hierarchy | A prefab or a model makes an instance; an image or a slice makes a sprite; several images or slices make a sprite that plays them; a material, onto a row, draws that entity with it. See Drop files from the Project panel. |
| The Scene view | The same, placed where the pointer is. See Drop files into the scene. |
| A slot in the Inspector | A file of the slot's kind is set in it. See Slots. |
| Build Settings, Addressables or the Animation window | Scenes dropped in the list of Build Settings go into the build there; files dropped on a group of Addressables become addressable in it; slices dropped on the Animation window's Sprite row become frames of the clip. |
Only one prefab or model at a time is placed by a drag. Where a drop cannot happen, the pointer says why.
Drag entities from the Hierarchy onto a folder to make prefabs of them; see Make a prefab and place instances.
Show in Explorer
Right-click a file, a folder or empty space for Show in Explorer on Windows, Reveal in Finder on macOS, or Open Containing Folder on Linux. It opens your file manager on the file, or on the open folder.
Search
Type in the search box to look through every folder at once. Every word you type must be in a file's name, and t: says what kind of file it is:
| Type | To find |
|---|---|
door | Files with "door" in their name |
t:image | Images |
t:model door | Models with "door" in their name |
The kinds are image, model, scene, prefab, script, shader, material, audio, controller, animationclip, uidocument, stylesheet, rust, webscript, dataasset, font and text, and part of a kind will do: t:anim finds clips. t= takes a kind exactly. The search lists files, not folders, and the path along the top says how many it found. In the list, each file shows the folder it is in. The × in the box clears the search, and so does opening a folder.
Import settings
Pick an image, a model, a sound or a text file under assets and the Inspector shows its import settings: how the editor reads the file for the engine. Change them, then Apply to import the file again with them, or Revert to go back to what they were. Both buttons stay grayed until you change something. See Importing, and for each kind's settings Textures, Models and Audio sources.
If you pick something else, or quit, with settings changed and not applied, the editor asks:
Unapplied import settings for 'models/door.gltf'.
Apply them?
They are lost if you revert them.- Apply (Enter) writes them.
- Revert lets them go.
- Cancel (Escape) shows the file again with your changes as you left them.
Picking one of the file's own slices or parts keeps the changes, and a file deleted or moved since is not asked about.
A prefab or a scene picked shows what it is and how it opens. A folder under assets shows whether it is addressable and the files in it. See Addresses and labels.
Several files at once
Several images, and nothing else, are one set of import settings, and so are several models, in any mix of glTF, GLB, FBX and OBJ. Each setting reads the first file's value, with a dash where another file differs. A change is made to every one of them, written by Apply and put back by Revert.
Any other mix shows how many of each kind are picked, such as 2 images and 1 folder, under Narrow the selection:. Click a kind to pick those alone.
Scripts in the Inspector
Pick a script and the Inspector shows the assembly the game builds it into, each component it declares, saying whether the build the editor has loaded has it yet, and its text, read-only and numbered, with Open. A style sheet, a Rust file and a web script show their text the same way.
Packages' files
When your game has packages, the switch at the left end of the panel's bar lists the project and each package, with its version. Pick a package to see its own folders, assets, scripts, shaders and the rest, as the panel's own; pick the project to go back. Manage Packages... at the end of the list opens the Package Manager. See Use packages.
Files changed outside the editor
The editor watches the project's folders. Files you add, rename or delete in your file manager, or that a pull brings, show in the panel a moment later, and the editor imports them. File ▸ Refresh (Ctrl+R) reads every folder again and builds the scripts.
