Blender Addon

Sortium Blender Addon

The Sortium Addon is 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 Integration Addon is designed to enhance your workflows and deliver exceptional outcomes.

Addon Installation Instructions

To install the Sortium addon, follow these steps:

  1. Download the addon file from the official Sortium website or from a trusted source.
  2. Install the addon in Blender using the regular addon installation process:
    • Launch Blender and go to the Edit menu.
    • Select Preferences to open the Blender Preferences window.
    • In the Preferences window, click on the Add-ons tab.
    • Click on the Install button located at the top right corner of the window.
    • Navigate to the downloaded addon file and select it. (Do not unzip the file!)
    • Click on the Install Add-on button to install the Sortium addon.
  3. If you have a previous installation of the Sortium addon, it is recommended to remove it before installing the new version. To do this:
    • Go to the Add-ons tab in the Blender Preferences window.
    • Search for the Sortium addon and disable it by unticking the checkbox.
    • Restart Blender to ensure the previous installation is completely removed.
  4. Once the Sortium addon is installed, enable it by ticking the checkbox next to its name in the Add-ons list.
  5. To access the Sortium addon, press the N key to open the right side panel in the 3D Viewport.
  6. Scroll down in the right side panel and locate the Sortium addon in the Tools tab.

Please note that following these steps will ensure a successful installation of the Sortium addon. If you encounter any issues, make sure to remove any previous installations and reset Blender before proceeding with the installation.

Addon Settings

  • API Key → Enter your Sortium user account's API Key credential in this field. This key is required to authenticate and access the Sortium backend services.
  • Assets Folder → Set the temporary folder path used by the addon to import retexture asset files. This folder serves as a temporary storage location during the asset retexture process.
  • Debug Mode → Use this toggle to control the display options of addon debug logs.
  • Create Base Material → Whether or not to create a base material for selection if asset does not contain any.

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 Blender Preferences window Sortium Addon. 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 the Sortium Blender addon tool for generating new procedural textures, follow the steps below:

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

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

  3. 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.

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

  5. 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 Active Session Generations panel.

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

  7. After the asset is processed successfully, if you have the same object active in the scene, the generated textures will replace the active textures. If no object is selected, or if the active object is different, the generated textures will be imported into the scene.

By following this workflow, you can easily generate new procedural textures for your selected objects using the Sortium Blender addon tool.

Material Modes

The Sortium Blender addon tool 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, the Sortium Blender addon tool 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
Clock 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.

Debugging and Logging Tips

When working with the Sortium addon, it can be helpful to review the logs for troubleshooting or debugging purposes. All logs related to the addon will be visible in the Blender terminal, where important information regarding the addon's functionality and operations is displayed.

To access the Blender terminal for log viewing, follow these steps:

  • In Windows or Linux: Go to the Window menu and select Toggle System Console. This will open the terminal window, displaying the logs.
  • In macOS: Blender terminal logs are accessible by opening Blender from the terminal itself. Launch the terminal and navigate to the location where Blender is installed. Then run the command to start Blender. The terminal window will now display the logs.

By reviewing the logs in the Blender terminal, you can gain valuable insights into the execution of the Sortium addon. This can help identify errors, provide context for any issues encountered, and assist in resolving any potential problems that may arise during workflow.

It is important to note that for macOS users, accessing the Blender terminal differs from other operating systems. Following the unique steps mentioned above will allow the terminal to display the addon logs when Blender is launched.

Utilizing these debugging and logging tips will enhance your experience with the Sortium addon, ensuring smooth operation and efficient troubleshooting when necessary.

Resources

For more information and resources, refer to the following:

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

Blender:
Explore Blender documentation to understand it's features and workflows.

Credits

The Sortium Blender Addon is developed and maintained by the Sortium team.


What’s Next