Add Windows Commands to TD Guide #189

Merged
Nick Alberelli merged 10 commits from TinyNick/blender-studio-pipeline:feature/add-windows-td-guide into main 2024-01-17 15:44:06 +01:00
Showing only changes of commit 876f169164 - Show all commits

View File

@ -46,9 +46,15 @@ TODO Replace Image with Project-Tools version
To launch Blender from the terminal, open the tools directory within your project folder, and from the terminal use the run Blender script.
```bash
# Linux/Mac
cd your_project_name/svn/tools
./run_blender.py
```
```bash
# Windows
cd your_project_name\svn\tools
python run_blender.py
```
::: warning Command Line Arguments
Note: Command Line Arguments also known as Flags are not supported by the `run_blender.py` script.
@ -63,17 +69,29 @@ Internally to the Blender Studio only, the blender inside your project is automa
:::
```bash
# Linux/Mac
cd your_project_name/svn/tools
./update_blender.py
```
```bash
# Windows
cd your_project_name\svn\tools
python update_blender.py
```
## Rollback Blender
Use `rollback_blender.py` to switch the "current" version hosted in `your_project_name/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
# Linux/Mac
cd your_project_name/svn/tools
./rollback_blender.py
```
```bash
# Windows
cd your_project_name\svn\tools
python rollback_blender.py
```
### Run a previous version of Blender Locally
@ -81,19 +99,42 @@ cd your_project_name/svn/tools
In some cases users may want to run a previous version of Blender on their machine without affecting other users.
```bash
# Linux/Mac
cd your_project_name/svn/tools
./run_blender_previous.py
```
```bash
# Windows
cd your_project_name\svn\tools
python rollback_blender_local.py
```
## Update Blender Add-Ons
Blender Add-ons can be packaged directly from the [Blender Studio Pipeline](https://projects.blender.org/studio/blender-studio-pipeline) repository. Personal Add-Ons can be installed [normally](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html#installing-add-ons).
1. Enter Directory
```bash
cd blender-studio-pipeline/scripts/pipeline-release
cd blender-studio-pipeline/scripts/pipeline-release # Linux/Mac
```
```bash
cd blender-studio-pipeline\scripts\pipeline-release # Windows
```
2. Update Git
```bash
# Windows & Linux/Mac
git checkout main # Checkout main branch
git reset --hard # Remove any changes stored in your branch
git pull --rebase origin # Pull to update to latest commit
./package_local.py your_project_name/shared/artifacts/addons
```
3. Run Package Local Script
```bash
./package_local.py your_project_name/shared/artifacts/addons # Linux/Mac
```
```bash
python package_local.py your_project_name\shared\artifacts\addons # Windows
```