diff --git a/README.md b/README.md index c7bdd15..b537091 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ --- +- [Getting Started](#getting-started) - [Why *Custom Templates*?](#why-custom-templates) -- [How to use](#how-to-use) -- [Support](#how-to-use) -- [Copyright](#how-to-use) +- [Support](#support) - [Changelog](./CHANGELOG.md) +- [Copyright](#copyright) --- @@ -16,7 +16,43 @@ Your templates will be avaliable in the Splash Screen and the `File > New` menu. -#### Why *Custom Templates*? +## Getting Started + +- **Prepare your templates** and save them **in `.blend` files** +*or find online `.blend` templates that fits your needs* +- **Define your templates** in the add-on's preferences + *It's simple. Select a `.blend` file and name your template.* + You can do this: + 1) Directly from add-on preferences, in the templates list + 2) By using `File > Defaults > Select new custom template` + *Popup to specify name and path for the new template.* + 3) By using `File > Defaults > Use current as new template` *(only avaliable when a saved .blend file is currently loaded)* + *Popup to specify the name for the new template. The path will be the one of the current .blend file.* + 4) By importing a previously exported templates list from JSON file + *(Either using `File > Defaults > Import/Export > Import Templates` as well as from the menu located in the top right of the templates list in the preferences)* + *Note: the import process override the current list. Be sure to export the current list, if necessary.* + +> *You can add, remove, reorder and update your templates any time...* + +- *(Optionally)* **Export** your templates list to **JSON file** + *Useful after disabling and re-enabling the add-on, re-installing blender, or simply to prepare different sets of templates to import when needed.* + +At this point your templates will be avaliable in the `File > New` menu and in the Splash Screen. + +> You can update the contents of your `.blend` templates at any time. The file is read each time you open the template. + +#### Splash Screen + +From the Splash Screen (or from preferences), you can easily switch between your Custom Templates and Blender's default templates. +> *This only applies to the splash screen. +> `File > New` menu will always show all your templates.* + +Notes: + +- With more than 5 templates, only the first 5 will be shown in the splash. If this is your case, be sure to reorder on top the 5 you want to see in the splash. +- If you have no templates currently defined, Blender's default list will always be used (to avoid empty list in splash) + +### Why *Custom Templates*? Blender allows you to save you own .blend file to use on startup. @@ -28,55 +64,20 @@ With **Custom Templates** you can setup as many .blend file as you like, as temp Create your own templates or find the ones that best suit your needs online. -*Customize workspaces, preset your usual materials, define additional windows and anything else you would like to have from the beginning.* +*Customize workspaces, preset your usual materials, define additional windows or anything else you would like to have from the beginning.* *The only limit is your immagination!* -### How to use - -- **Prepare your templates** and save them **in `.blend` files** -*or find online `.blend` templates that fits your needs* -- **Define your templates** in the add-on's preferences - *Simply select a `.blend` file and name your template* - You can do this: - 1) Directly from add-on preferences, in the templates list - 2) By using `File > Defaults > Select new custom template` - *This functions will open a popup where you will select the file path and specify the name for the new template.* - 3) By using `File > Defaults > Use current as new template` *(only avaliable when a saved .blend file is loaded)* - *This functions will open a popup where you will specify the name for the new template. The path will be the one of the current .blend file.* - 4) By importing a previously exported templates list - *Note: the import process override the current list. Be sure to export the current list, if necessary* - -> *You can add, remove, reorder and update your templates any time...* - -- *(Optionally)* **Export** your templates list to **JSON file** - *Useful after disabling and re-enabling the add-on, re-installing blender, or simply to prepare different sets of templates to import when needed.* - -At this point your templates will be avaliable in the `File > New` menu and in the Splash Screen. - ---- - -##### Splash Screen - -From the Splash Screen (or from preferences), you can easily switch between your Custom Templates and Blender's default templates. -> *This only applies to the splash screen. -> `File > New` menu will always show all your templates.* - -Notes: - -- With more than 5 templates, only the first 5 will be shown in the splash -- If you have no templates currently defined, Blender's default list will always be used - ### Support As of today, the add-on has been only tested on Blender 4.2.x. *It may or may not work on previous version.* +### Changelog + +Visit the [CHANGELOG](./CHANGELOG.md) file to see the changes over new version. + ### Copyright This add-on is developed under GPL-3.0 license by Francesco Bellini from 2024. *See the [LICENSE](./LICENSE) file.* - -#### Changelog - -Visit the [CHANGELOG](./CHANGELOG.md) file to see the changes over new version.