Docs: Project Tools Update #156

Merged
Nick Alberelli merged 59 commits from :docs/project-tools-update into main 2023-10-19 22:21:50 +02:00
Showing only changes of commit 2749877beb - Show all commits

View File

@ -0,0 +1,70 @@
# Running Blender
## Launch Blender from Taskbar/Start Menu
<!---
TODO Add INFO box to direct users to TD Guide to set this up for your specific OS
--->
::: info Available on Gentoo
To learn more about running the Blender if you are on a Gentoo system please see the [Gentoo guide](/gentoo/user/running-blender.md), including how to run a [debug build](/gentoo/user/running-blender.md#debug-build).
:::
Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder.
<!---
TODO
- Add this to TD Guide too
-Verify Python Version
--->
::: info Python Requirement
Running this script requires python 2.7+, please ensure python is installed on your system before running blender with the below instructions
:::
1. Search for Blender in your Application Launcher
2. The application with the name `blender {my_project}` without any suffix is the latest build.
<!---
TODO Replace Image with Project-Tools version
--->
![Image of Blender Icon in KDE Taskbar/Start Menu](/media/user-guide/launch_blender.mp4)
## Launch Blender from Terminal
To launch Blender from the terminal, open the tools directory within your project folder, and from the terminal use the run Blender script.
```bash
cd /data/my_project/svn/tools
./run_blender.py
```
## Update Blender
<!---
TODO You can specify the branch to fetch by editing the `BLENDER_BRANCH` variable in the script file.
--->
This script will fetch the latest Blender download from https://builder.blender.org/download/ The Blender download for Linux, Mac, and Windows will be downloaded into the `{my_project}/shared/artifacts/blender` folder. It will keep up to 10 previous downloaded versions for backup.
```bash
cd /data/my_project/svn/tools
./update_blender.py
```
## Rollback Blender
Use `rollback_blender.py` to switch the "current" version hosted in `{my_project}/shared/artifacts/blender` to one the older downloads, rolling back affects all users using your project. This is intended to be used to rollback to an older version in case of bugs in newer downloaded versions.
```bash
cd /data/my_project/svn/tools
./rollback_blender.py
```
### Rollback Blender Locally
In some cases user may want to roll their machine's local blender to a previous version without affecting other users.
```bash
cd /data/my_project/svn/tools
./rollback_blender_local.py
```