UnigineEditor
Interface Overview
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Assets Workflow

The Asset System aims to unify file management within the UNIGINE project and make it simple and intuitive. For this purpose the content of the project is represented as a collection of "building blocks" - assets, and the whole workflow is organized around them.

Asset is the "unit of work", it represents any item that can be used in your world or project. An asset may come from a file created using a third-party application, such as a 3D model, an audio file, an image, or any other type supported by the UNIGINE Engine. Assets can also be created using the UnigineEditor, e.g., a node, a material, or a property.

Each asset is represented by a pair: a file on disk, and a *.meta metadata file which stores auxiliary information for this asset including a GUID (globally unique identifier). A GUID identifies a path to the asset (i.e., location of the asset in the project) and is used by the Asset System to keep all links and dependencies between the resources regardless of their name and location within the project. So, you don’t have to worry that your material will lose a texture when you change its name.

Another important feature of the Asset System is real-time tracking of changes. You can modify your assets at any time after importing, the Asset System will notice when you save new changes to the file and will re-import it as necessary.

All assets are stored in the data folder of your project. For all assets, that are in non-native format (e.g. .fbx, .obj, .hdr, etc.) the Editor automatically generates all resources to be used by the UNIGINE Engine at run time. Such files are called runtime files.

Notice
Runtime files are generated automatically and stored in the data/.runtimes folder of your project.

Relationship between the contents of the data folder in your project's root on your computer, and the Project folder in the Asset Browser window

The entire workflow will revolve around the Asset Browser, and the regular file explorer should no longer be necessary when working on a UNIGINE project. In fact, the goal of this feature is for users of UNIGINE to ignore what lies on the disk completely and only interact with their project's content via the Editor.

Asset Browser#

The main front-end tool of the Asset System is the Asset Browser. It is used to organize content in your project: create, import, view, rename your assets, move them between the folders and manage their hierarchy.

Notice
The simplest way to safely move or rename your assets is to always do it using the Asset Browser. In this case the Asset System will keep all links and dependencies between the resources.

The Asset Browser is accessible from the Window menu.

Asset Browser window

Folder View Panel#

Folder View panel is located on the left side of the Asset Browser interface. It contains a list of all folders within your project.There are two root folders available:

  • Project folder - contains the data stored in the data folder of the project root. It is the folder where all work with the project content is performed.
  • Core folder - contains the built-in core assets. These assets are available for every project by default.
    Notice
    Core assets are read-only.

When a folder is selected from the list by clicking, its contents will be shown in the Main panel to the right. You can use small triangle next to the folder to expand or collapse it, displaying any nested folders it contains.

Main Panel#

Main panel in the center of the Asset Browser window displays icons for all assets in the selected project folder after applying all selected filters. You can select the types of assets to be displayed using the Filter dropdown at the top of the panel.

The assets available in the Asset View can be dragged directly into the scene viewport.

You can create a new folder, material or property by right-clicking somewhere within the panel and choosing the desired item from the context menu (or you can use the Create button in the top-right corner). The list of assets can be navigated by using the scroll bar or rotating the mouse wheel.

The icons can be resized using the slider at the bottom of the panel; they will be replaced by a hierarchical list view if the slider is moved to the extreme left.

To show the asset file location in the standard file browser window, right-click on the asset and choose Show in Explorer.

You can also search the required asset among all assets of the project (including the ones stored in the core folder). In the Search field, start typing the asset name: all assets that fulfil search conditions will be displayed.

Preview Panel#

Preview panel is located on the right side of the Asset Browser interface. It displays the preview of the asset selected in the Main panel depending on its type.

3D Geometry Material Texture

3D geometry Asset (such as .mesh, .node, .fbx) is shown in a test environment with default mesh_base base material applied.

You can rotate the model with a mouse, holding the left button pressed, and scale it with the mouse wheel.

Material asset is shown as applied to a primitive (Sphere, Material Ball, Box, Capsule, Cylinder, Dodecahedron, or Icosahedron).

You can rotate the primitive with a mouse, holding the left button pressed, and scale it with the mouse wheel.

A texture asset is shown as an image, with information and controls at the top of the panel. These controls are used to select Red, Green, Blue and Alpha channels and MipMapping level.

You can move the image with a mouse, holding the left button pressed, and scale it with the mouse wheel.

Audio player is displayed for an audio asset. Previews for other asset types are displayed as icons.

Last update: 2019-11-28