Blender Crawl: Improvements based on User Feedback #53

Merged
Nick Alberelli merged 11 commits from fix/blender-crawl-improvements into main 2023-05-22 16:50:42 +02:00
Showing only changes of commit 4d2f6d0ff6 - Show all commits

View File

@ -31,13 +31,16 @@ Steps 3 and 5 are specific to linux, similar steps are avaliable to [Windows](ht
## How to get started
Run directly out of repo folder or follow above installation instructions. Give `blender_crawl` a path to a .blend file or a folder as first argument, The detected blend files will be opened in the background, the python script will be executed, and the file closes. If blender is not installed at the default location of your computer, you need to provide a blender executable using the --exec flag.
If a script is provided, `blender_crawl` will automatically save after execution of the script, without saving any backups aka [save versions](https://docs.blender.org/manual/en/latest/editors/preferences/save_load.html#:~:text=of%20using%20characters.-,Save%20Versions,-Number%20of%20versions). If you already have saving logic in your provided script, skip this step using the "--nosave" flag.
| Command | Description |
| ----------- | ----------- |
| --script| Path to blender python script(s) to execute inside .blend files during crawl.|
| -n, --nosave|Don't save .blend after script execution.|
| -r, --recursive| If provided in combination with a folder path will perform recursive crawl|
| -f --filter| Provide a string to filter the found .blend files|
| -a, --ask| If provided there will be a prompt for confirmation before running script on .blend files.|
| -p, --purge| Run 'built-in function to purge data-blocks from all .blend files found in crawl.'.|
| -p, --purge| Run 'built-in function to purge data-blocks from all .blend files found in crawl, and saves them.|
| --exec| If provided user must provide blender executable path, OS default blender will not be used if found.|
| -h, --help| show the above help message and exit|
@ -52,5 +55,6 @@ Run directly out of repo folder or follow above installation instructions. Give
|Run default 'Purge' script on .blends in Current Directory |`blender_crawl /my-folder/ --purge`|
|Run custom script on all .blends in Current Directory |`blender_crawl /my-folder/ --script /my-directory/my-script.py`|
|Ask/Prompt before script execution|`blender_crawl /my-folder/ --script /my-directory/my-script.py --ask`|
|Run script on .blends without saving |`blender_crawl /my-folder/ --script /my-directory/my-script.py --nosave` |
|Run with a custom blender executable|`blender_crawl /my-folder/ --exec /path-to-blender-executable/blender`|