Blender/custom-templates-addon
Blender/custom-templates-addon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Re-oranized and simplified README

Browse Source
This commit is contained in:
doc-code 2024-08-31 19:39:28 +02:00
parent 45fc4ebf78
commit ae8fd3c3d2
2 changed files with 32 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
CHANGELOG → CHANGELOG.md
View File

85
README.md
View File

@ -2,11 +2,11 @@
![File > New menu with the add-on custom buttons](./images/Preview%20Image%20-%20v2.png)
Custom Templates Add-On allows you to use your own .blend files as template options for new projects.
**Custom Templates** allows you to use your own .blend files as template options for new projects.
Your templates will be avaliable in the Splash Screen and the `File > New` menu.
#### Why this add-on?
#### Why *Custom Templates*?
Blender allows you to save you own .blend file to use on startup.
@ -16,61 +16,50 @@ With **Custom Templates** you can setup as many .blend file as you like, as temp
---
Instead of being limited to the usual options Blender offers to start a new project (General, 2D Animation, Sculpting, VFX, Video Editing), you will be able to configure your own list of .blend files that will be added in the Splash Screen and the `File > New` menu.
Create your own version of General, 2D Animation or any other template you might need.
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.*
### Preferences
*The only limit is your immagination!*
In the add-on preferences, you can manage the list of your custom template files and the splash screen mode.
### How to use
Preferences:
- Templates: List of your custom templates (each with Name and Path to .blend file)
- Override Splash Screen 'New File' list: When active, replaces the list of templates in the Splash Screen
*(you can update this settings directly from the splash screen menu of the add-on)*
You can add, remove and reorder templates as you wish.
It's possible to Import and Export from and to JSON file (see [Import/Export just below](#importexport)).
*Changes will be immidiatly visible.*
![Custom Templates Preferences](./images/Addons_Preferences%20-%20v2.png)
You can have as many template as you like.
*Still, the splash screen will be limited to the first 5, so reorder accordingly if you have more...*
> *Note that, as of now, using wrong file paths will NOT show any warning and you will get an error while opening the template.*
> *Be sure to use only valid `.blend` files as path.*
### Features
##### Open Template
Of course, the main feature of the add-on is to show your list of templates in the `File > New` menu and in the Splash Screen, according to preferences.
They will open in an unsaved windows, just like the Blender's default ones.
##### Manage templates
You can open the add-on preferences using the button `File > Defaults > Manage templates` or by manually open Blender's Preferences, going in the add-ons tab, and looking for the Custom Templates add-on preferences.
##### Import/Export
Both from the add-on preferences menu and the `File > Default > Import/Export` menu, is possibile to export the current custom templates list to a JSON file, or importing an existing JSON file and using it to override the current custom templates list.
> *Note that this will only backup names and paths. This is not intended as a backup for your .blend files.*
##### Select new custom template
Instead of using preferences, you can select a new template file using `File > Defaults > Select new custom template`.
- **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.*
##### Use current as new template
If you have a .blend file already open, you can use `File > Defaults > Use current as new template` (which is visible only when a saved .blend file is currently loaded).
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.0.
As of today, the add-on has been only tested on Blender 4.2.x.
*It may or may not work on previous version.*
### Copyright
@ -80,4 +69,4 @@ This add-on is developed under GPL-3.0 license by Francesco Bellini from 2024.
#### Changelog
Visit the [CHANGELOG](./CHANGELOG) file to see the changes over new version.
Visit the [CHANGELOG](./CHANGELOG.md) file to see the changes over new version.