adds documentation

This commit is contained in:
Michel Fedde 2024-02-02 10:32:27 +01:00
parent df765f020a
commit 09ceff62f3
11 changed files with 97 additions and 20 deletions

View file

@ -1,13 +1,14 @@
# Blender - Bake ID Mask Plugin
# Blender - ID Mask Tools
A plugin to quickly bake ID masks for meshes from/to different sources and targets.
A set of tools to quickly create ID masks for meshes.
### Currently supported:
Sources:
- Material Index
### What is this?
For usage in specific programs like Substance Painter, its useful to create a mask for specific parts for your mesh, so you can easily make out parts of the mesh, to f.E. apply a mterial.
You can specify colors in color attributes that define "IDs" for specific parts of the mesh, which you can then use in different programs.
Targets:
- Vertex Color
Currently this workflow requires you to assign them tediously by using a mixture of Edit Mode and Vertex Paint to paint the mesh correctly.
This plugin tries to fix that, by providing proper tools for it. The most important is probably the [ID Mask Editor](docu/features/id_mask_editor.md), that allows you to quickly add IDs to faces all within the Edit Mode.
## Installation
1. Download the newest file from the releases tab.
@ -16,12 +17,4 @@ Targets:
4. After selecting it, just enable it and done.
## Usage
You find the tool in the panel on the right of the "3D Viewport" under "Tool".
![Panel Location](docu/images/panel.png)
How to use properly it, highly depends on the selected source.
### Usage - Material Index Source
Here the IDs are given based on the object and its material indices.
Lets say, you have 10 objects and each has 2 materials attached to it. Then the amount of IDs given is 20, since each object contains the two material indecies.
Check out the [Features](docu/features.md) page to find more specific information about the usage of each feature.