Include Addon READMEs in Pipeline Docs #49

Merged
Nick Alberelli merged 18 commits from docs/addon-readmes into main 2023-05-17 17:52:31 +02:00
12 changed files with 47 additions and 19 deletions
Showing only changes of commit fec51dca21 - Show all commits

View File

@ -3,11 +3,17 @@
Miscellaneous operators and tools requested by Blender Studio Animators.
## Table of Contents
- [Installation](#installation)
- [Features](#features)
- [Select Similar Curves](#select-similar-curves)
- [Lock Curves](#lock-curves)
- [Easy Constraints](#easy-constraints)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `anim_cupboard` folder. Place this folder in your Blender addons directory or create a sym link to it.
## Features
### Select Similar Curves

View File

@ -21,8 +21,9 @@ asset-pipeline is a Blender Add-on that manages the Asset Pipeline of the Blende
## Installation
Download or clone this repository.
In the root project folder you will find the 'asset_pipeline' folder. Place this folder in your Blender addons directory or create a sym link to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `asset_pipeline` folder. Place this folder in your Blender addons directory or create a sym link to it.
> **_NOTE:_** This add-on depends on other add-ons that are in the [Blender Studio Tools](https://developer.blender.org/diffusion/BSTS/).

View File

@ -32,8 +32,9 @@ blender-kitsu is a Blender Add-on to interact with Kitsu from within Blender. It
- [Development](#development)
## Installation
Download or clone this repository.
In the root project folder you will find the 'blender_kitsu' folder. Place this folder in your Blender addons directory or create a sym link to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `blender_kitsu` folder. Place this folder in your Blender addons directory or create a sym link to it.
## How to get started
After installing you need to setup the addon preferences to fit your environment.

View File

@ -7,7 +7,9 @@ blender-svn is a Blender add-on to interact with Subversion from within Blender.
- [Installation](#installation)
- [Features](#features)
## Installation
You can install the add-on by cloning the Blender Studio Tools repository using git, and then copying the blender-svn/blender_svn folder (the deeper one) into your "addons" folder (location depending on your OS).
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `blender_svn` folder. Place this folder in your Blender addons directory or create a sym link to it.
## Features
- UI appears when the currently opened .blend file is in an SVN repository.

View File

@ -1,11 +1,17 @@
# Bone Gizmos
## Table of Contents
- [Installation](#installation)
- [What are Bone Gizmos?](#what-are-bone-gizmos)
- [Using Bone Gizmos](#using-bone-gizmos)
- [Rigger UX](#rigger-ux)
- [Animator UX](#animator-ux)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `bone_gizmos` folder. Place this folder in your Blender addons directory or create a sym link to it.
## What are Bone Gizmos?
This add-on is a prototype for a potential future Mesh Gizmos feature in Blender. See [this](https://developer.blender.org/T92218) task for more details.

View File

@ -11,8 +11,9 @@ cache-Manager is a Blender Add-on to streamline the alembic cache workflow of as
## Disclaimer
This addon is not used in the production of the Blender-Studio anymore and is not maintained actively.
## Installation
Download or clone this repository.
In the root project folder you will find the 'cache_manager' folder. Place this folder in your Blender addons directory or create a sym link to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `cache_manager` folder. Place this folder in your Blender addons directory or create a sym link to it.
## How to get started
After installing the addon you need to setup the addon preferences.

View File

@ -8,8 +8,9 @@ Blender Add-on to create a contactsheet from sequence editor strips.
- [Features](#features)
- [Development](#development)
## Installation
Download or clone this repository.
In the root project folder you will find the 'contactsheet' folder. Place this folder in your Blender addons directory or create a symlink to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `contactsheet` folder. Place this folder in your Blender addons directory or create a symlink to it.
## Features
After the addon is enabled you will find a `Contactsheet` tab in the Sequence Editor Toolbar.

View File

@ -6,8 +6,9 @@ GeoNode Shape Keys is a Blender Add-on that lets you deform linked and overridde
- [How to Use](#how-to-use)
## Installation
Download or clone this repository.
In the root project folder you will find the 'geonode_shapekeys' (the one with the underscore, not the dash) folder. Place this folder in your Blender addons directory or create a symlink to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `geonode_shapekeys`a Place this folder in your Blender addons directory or create a symlink to it.
# How to use
The add-on's UI is only visible on linked and overridden meshes.

View File

@ -9,8 +9,9 @@ grease-converter is a Blender Add-on that can convert annotations to grease penc
## Installation
Download or clone this repository.
In the root project folder you will find the 'grease_converter' folder. Place this folder in your Blender addons directory or create a symlink to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `grease_converter` folder. Place this folder in your Blender addons directory or create a symlink to it.
## How to get started
After the add-on is installed you have 2 new operators available.

View File

@ -8,8 +8,9 @@ System to create, manage and apply python overrides in a flexible and reliable w
## Installation
Download or clone this repository.
In the root project folder you will find the 'lighting_overrider' folder. Place this folder in your Blender addons directory or create a symlink to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `lighting_overrider` folder. Place this folder in your Blender addons directory or create a symlink to it.
## Features
- Shot Settings

View File

@ -1,7 +1,7 @@
# Pose Shake Keys
## Table of Contents
- [Installation](#installation)
- [Basic Workflow](#basic-workflow)
- [Example Use Cases](#example-use-cases)
@ -11,6 +11,12 @@ It also lets you manage multiple copies of a shape key together. Each copy can h
You can find a detailed video tutorial on how to download, install and use the addon [here](https://studio.blender.org/training/blender-studio-rigging-tools/pose-shape-keys/).
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `pose_shape_keys` folder. Place this folder in your Blender addons directory or create a sym link to it.
## Basic Workflow:
- Create a pose whose deformation you want to correct. A pose is defined as an Action and a frame number.
- Create a Pose Key on the deformed mesh. Assign the action and the frame number.

View File

@ -8,8 +8,9 @@ Blender Add-on to review renders from Flamenco with the Sequence Editor
- [Development](#development)
## Installation
Download or clone this repository.
In the root project folder you will find the 'render_review' folder. Place this folder in your Blender addons directory or create a sym link to it.
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `render_review` folder. Place this folder in your Blender addons directory or create a sym link to it.
After install you need to configure the addon in the addon preferences.