shown in other instead.
While working with a project, you create, copy, move, inherit, rename, and delete assets. As a result, an enormous amount of unnecessary files can be created.
Cleaner is a tool used to optimize your project and save disk space by deleting assets that won’t later be used in the final build. Cleaner also checks for corrupted references to assets.
Cleaner checks each asset that your project contains and displays irregularly used assets.
To open the Cleaner window, choose Tools -> Cleaner on the Menu Bar of UnigineEditor.
The Cleaner window will open:
This tab displays the assets that are not used in any of the files included in your project (worlds, layers, nodes, meshes, materials) and not referenced from code in any of your source files stored in your project source/ folder, but still exist in the project.
Cleaner shows the file name and asset type for unused assets. As you click an unused asset in Cleaner, it is displayed in the Asset Browser and the Parameters window.
You can delete any or all of the displayed assets by using the Cleaner functionality.
The Unused Assets list also includes all assets that were referenced from the unused assets.
- Delete Selected — deletes only the selected assets from the list of unused assets. This option is also available by right-clicking the selected files in Cleaner.
Delete Listed — deletes the whole list of currently displayed assets.Use delete buttons carefully. Deleted assets cannot be restored.
Show Ignore List... — displays the ignore list that already contains the default list of wildcards used to define the scope of check by Cleaner. This list can be extended by the user.If a filename in your project is generated in code (for example, a string concatenated from several words), add such cases to the Ignore List. Otherwise, such files will be deleted.
Upon clicking the Check button, all project files left after applying the ignore list (i.e. the ones that are not ignored by Cleaner and, thus, will be checked) are displayed in the bottom part of the Ignore List window.
This tab displays the assets referenced to by GUID but are not available in the project.
As you click a lost asset, the asset containing a reference to it, is displayed in the Asset Browser and the Parameters window. Fixing of lost assets is possible only manually.
The table in the Lost Assets tab has three columns:
- Lost Asset — shows the GUID of the lost asset.
- Asset File — shows the name of the file containing the reference to the lost asset.
- Node Name — shows the name of the node, if the file containing the reference includes the node that actually has a reference to the lost asset.
This tab displays the runtime files generated for the assets that are not available in the project, but referenced by a node/nodes in the scene.
The table in the Lost Runtimes tab has three columns:
- Runtime Path — shows the path to the lost runtime file.
- Asset — shows the name of the file containing the reference to the asset, for which the lost runtime file was generated.
- Node Name — shows the name of the node, if the file containing the reference includes the node that actually has a reference to the asset, for which the lost runtime file was generated.
Lost runtimes are managed using the buttons available on the tab. The buttons are the same as for the Unused Assets:
- Delete Selected — deletes only the selected runtimes from the list of unused runtimes. This option is also available by right-clicking the selected files in Cleaner.
Delete Listed — deletes the whole list of currently displayed runtimes.Use delete buttons carefully. Deleted files cannot be restored.
This tab displays groups containing files with a high degree of visual similarity. You may want to find and delete extra files to save more space in your project.
|Directory||Directory that contains the assets to be compared.|
|Similarity Threshold||The extent of visual similarity based on which similar files are grouped.|
|Preview Resolution||Resolution of the image preview that will be used as the basis for comparison.|
|Resolution of Compared Images||Resolution of other image previews that will be compared with the basis.|
|Similarity||The minimum percentage of similarity between all selected files.|
After you click the Refresh button, the comparison process will start. The result of this process will be displayed as the list of groups, each group containing a files with a visual similarity exceeding the Similarity Threshold value. Files can be managed via the context menu available by right-clicking on the file in the list.
Information on time spent to complete the Cleaner processes can be printed to the console and the log file: you just need to set the UNIGINE_EDITOR_TIME_TRACE environment variable.
Click Refresh to check the project for lost and unused assets.
You can narrow the search scope by specifying a directory in the Directory field: Cleaner will display and manage the lost and unused assets from the specified directory only. To see results after setting (or resetting ) the directory, click Refresh once again.
After analyzing assets in your project, Cleaner shows the following details.
Manage unused assets using the buttons available on the Unused Assets tab.Use delete buttons carefully. Deleted assets cannot be restored.
- Click Refresh to update the list. Deleting unused assets can reduce the number of lost assets.
- Fix Lost Assets. Fixing of lost assets is possible only manually — by checking each asset displayed in the second or third column.
Manage Lost Runtimes using the buttons available on the tab. The buttons are the same as for the Unused Assets.Use delete buttons carefully. Deleted files cannot be restored.
- Search for the similar assets in your project and consider if one and the same asset can be used instead of several.
Watch the video below to learn how to delete unused assets with the Cleaner tool.