Skip to content

Documentation

Jishnu kv edited this page Jan 11, 2024 · 10 revisions

Setting the Project

  • Presets: Select from the default two presets or create custom presets in the add-on preferences. If you configure settings with the 'Custom' option selected and then attempt to switch to other presets, the data from the custom option won't be saved. Therefore, upon switching back to 'Custom,' you'll see the data from the last preset you used.

  • Project Name & Path: Set the name and location of your project.

    • Project Name: Specify the name for your project.
    • File Name: Specify a name for your file. This option is only available if the file name toggle is on.
    • Project Location: Set the location where your project will be saved.
  • Folder Names: Manage the folders in your project.

    • Folder Name: Specify the name for the new folder. If you name a folder 'Render', 'Image', or 'Images', it will serve as the destination for render outputs. Naming a folder 'Scene' or 'Scenes' designates it for saving Blender files.

    • Remove Folder: Remove a folder from the folder names.

    • Add Folder: Add a new folder to your project.

  • Save Options: Save options

    • File Name: Save the file with custom name instead of the project name.

    • Save: Save your project.

    • Relative Remap: Remap relative paths.

    • Compress: Compress your project.

Save Project: Save your project. Once the project is saved, the option to toggle the file name on or off is fixed and cannot be changed.

Updating the Project

Update Project

  • Folder Names:

    • Remove Folder: Remove a folder from the folder names.

    • Delete Folder: Delete a folder from your project folder.

    • Refresh Folders: Display folder names created outside of Blender. You can configure external folder access via preferences, including the option to toggle the feature on or off, automatically display folder names, and change the folder checking interval.

    • Add Folder: Add a new folder to your project.

  • Update Project: Use this option to update your project if you've added new folders or modified the save options. If you need to move the project to another folder:

    1. Move the project folder using Windows Explorer or Files V2.

    2. Open the Blender file from the new project location.

    3. In the Set Project panel, you will find a button labeled "Update Project Location." Clicking on it will set the new location.

  • Open Folder: Open the project folder.

  • Update Project Location: Check if the project location has changed and update it if necessary.

Warning

Addon Preferences

This section outlines the various preferences available in the Set Project addon.

Info

Info

The "Info" section provides useful information about specific folder names and their roles within the project. Understanding these naming conventions is crucial for efficient project management.

  • Render Output Path: If the folder name is 'Render', 'Image', or 'Images', it will be utilized as the render output path.
  • Blender File Saving Folder: If the folder name is 'Scene' or 'Scenes', it will be used as the directory for saving Blender files.

Preset Settings

Preset

The "Preset Settings" section allows users to manage presets for their projects. Presets capture specific configurations, making it easy to apply predefined settings.

  • Presets Dropdown: Select from a list of default presets or create custom presets in the addon preferences. Note that switching from a custom preset to another may not save data configured under the custom option. Be cautious when changing presets.

Experimental Features

Experimental

The "Experimental Features" section houses advanced options that enhance the functionality of the Set Project addon.

  • Enable Experimental Features: Toggle to enable or disable experimental features.

  • Update Folders Mode: Choose the mode for updating folders:

    • Automatic: Folders are updated automatically.
    • Manual: Manually refresh folders using the "Refresh Folders" button.

These experimental features may offer additional capabilities but should be used with caution as they are still under development.

Check For Updates

Check For Updates

Check for add-on updates. When checking is complete, you will see a "New Update Available" if a new update is available. Clicking on it will take you to the Blender Market Orders page. If the add-on is up-to-date, a button will indicate "Add-on is Up to Date" along with a "Check for Updates" button for future checks.