Unity Plugin

Sortium Unity Plugin

A powerful tool that offers a comprehensive set of specialized tools designed to facilitate the creation of top-tier assets for 3D models. By seamlessly integrating with Sortium APIs, an advanced AI-powered asset creation platform, this addon streamlines the asset creation and retexturing pipeline and helps users achieve visually stunning results. Whether you are involved in game development, gaming, or virtual production, the Sortium Unity Plugin is designed to enhance your workflows and deliver exceptional outcomes.

Plugin Installation Instructions

This guide will help you set up the plugin in your Unity project. Follow these steps to get started quickly.

  • Extract the ZIP archive and move Sortium folder inside your Unity Project Assets folder.
  • Install GLTFast plugin dependency
    • In your Unity project, go to Windows > Package Manager.
    • On the status bar, select the Add (+) button.
    • From the Add menu, select Add + package by name. Name and Version fields appear.
    • In the Name field, enter com.unity.cloud.gltfast.
    • Select Add.
    • The Editor installs the latest available version of the package and any dependent packages.
    • Make sure you have version 6.0.7 or higher of GLTFast package installed.

For more information and resources, refer to the following:

Unity Plugins

GLTFast

Setup Plugin

In Unity Editor top bar, click on Tools, select Tools > Sortium > Generate from the editor menu.

Welcome Screen


Enter your Sortium user account's API Key credential in this field. This key is required to authenticate and access the Sortium backend services

Click Save API Key to get started. This setup is required only once if you haven't set your API Key previously.

You can clear an existing API Key if you wish under preferences in Edit > Project Settings > Sortium > Clear API Key.

Other Settings

  • Environment: Define the environment as Production for Sortium integration.
  • Assets Folder → Set a desired assets folder path to be used by the plugin to import retexture asset process file results. This folder must exist inside your Unity/Assets project folder.
  • Enable Logs → Use this toggle to control the display options of plugin debug logs.

Obtaining an API Key

To access and authenticate with the Sortium backend services, you will need to obtain an API Key. This key serves as your credential to access Sortium's powerful features and functionalities.

To get an API Key, please visit Sortium API Key Page and follow the instructions provided. Once you obtain the API Key, you can enter it in the api key field within Unity Project Settings window in Sortium section. This will enable seamless authentication and grant you access to Sortium's advanced asset creation and retexturing capabilities.

Please ensure that you keep your API Key secure and do not share it with unauthorized individuals. It is a vital component of accessing Sortium's services and maintaining the privacy and security of your account.

Retexture Workflow

To use Sortium Plugin for generating new procedural textures, follow the steps below:

  1. Select all the objects in the scene that you want to retexture.

  2. Open plugin window by clicking on Tools > Sortium > Generate.

  3. Click Load Materials button. This action will generate a prompt parameters form interface to customize the retexture parameters according to your preferences in plugin's side menu containing specs for each material in the selected objects.

  4. Fill in the prompt parameters as desired for each material.
    Alternatively, you can use the All Materials option to apply the same prompt to all materials in the active selection.

  5. Once all the parameters are fulfilled as desired, click Generate Texture button.

  6. The addon will process the interaction and generate new textures based on the selected prompt parameters. The progress and results will be displayed in the Tasks panel.

  7. In preview mode, you can select to view your generation inside the plugin window.

  8. If you want to clear all the parameters and reset them to their default values, you can click the Reset Defaults button.

  9. After reviewing and confirming the resulting asset, you can toggle off the preview mode within the plugin window settings.


    This action will trigger the download of the final asset file to the specified Assets Folder path, as defined in the plugin project settings.


    Additionally, after toggling preview mode off, you can click to download assets from your library into your project's Assets folder.

3D Workflow

  1. Begin with no objects selected in your scene and open the plugin window by clicking on Tools > Sortium > Generate.

  2. Enter a descriptive prompt in the input field and click Generate

  3. The addon will process the interaction and generate 3 asset previews based on your prompt. The progress and results will be displayed in the Tasks panel.

  4. Select to view your previews. You can now select which assets to Generate, or select Refresh to request new preview results.

  5. Generations will be processed as tasks and, with preview mode enabled, you can select to view your finalized asset inside the plugin window.

  6. After reviewing and confirming the resulting asset, you can toggle off the preview mode within the plugin window settings and select to download assets from your library into your project's Assets folder.

Material Modes

The plugin offers two material modes for generating procedural textures: All Materials and Multi Material.

ModeMaterial Parameters
All MaterialsIn this mode, the prompt parameter needs to be filled in for All Materials option. This mode allows you to apply the same prompt to all materials in the active selection.
Multi MaterialWhen any material is selected, the multi material mode is activated. In this mode, you have the flexibility to customize and control the texture generation for each material individually. At least one material must have a non-empty prompt field (fulfilled).

By providing these two material modes, Sortium plugin allows you to generate unique and detailed textures for each material in your object. This enhances the visual quality and realism of your 3D assets, giving you precise control over the texture generation process.

Tasks

Tasks are processed on the server, therefore it is essential to click the Refresh Button in tasks panel in order to retrieve the most up-to-date status of each task.

Tasks panel contains all retexture requests for Sortium. When a user makes a retexture request, it is added to the panel section with relevant details such as the prompt status of the asset, timestamp, and any specific instructions. The section serves as a centralized hub for tracking and prioritizing retexture requests. Users can easily monitor the progress and completion status of each request, ensuring efficient and timely retexturing of assets.

StatusInfo
Refresh IconSystem is actively working to generate the re-textured asset based on your input and prompts.
Down ArrowRetexture Asset Processed and Ready To Be Imported In The Scene

Library

Stores and organizes past retexture requests made by the user across multiple sessions. It provides a comprehensive record of previous retexture requests, allowing users to refer back to their prompts, review details, and make necessary modifications or updates. This feature ensures easy access to users' entire retexture history, facilitating efficient management of assets.

StatusInfo
ReceivedRetexturing task has been received by the queue but has not yet started.
ProcessingSystem is actively working to generate the re-textured asset based on your input and prompts.
ProcessedRetextured asset is ready for viewing and further actions.
FinalizedRetextured asset is ready for download using Interaction item download button.
ErrorFurther action or investigation may be needed to address the failure.

Debug Mode

Enabling the debug mode in Edit > Project Settings > Sortium > Enable Logs initiates the display of logs on Unity's output logs. This feature is particularly useful for monitoring and troubleshoot various processes within the plugin.

By toggling this mode on, you gain visibility into detailed logs, providing valuable insights into the plugin's functionality and any potential issues encountered during execution. Once enabled, you can access and analyze these logs directly within Unity's output logs interface, aiding in the debugging and optimization of your project.

Resources

For more information and resources, refer to the following:



Sortium
Visit Sortium website to learn more about the platform and its capabilities.


Unity
Explore Unity documentation to understand it's features and workflows.

Credits

The Sortium Unity Plugin is developed and maintained by the Sortium team.