Skip to content

Commit 869f058

Browse files
author
kosmin
committed
Updating Documentation
1 parent 1df0d8b commit 869f058

File tree

1 file changed

+84
-19
lines changed

1 file changed

+84
-19
lines changed

readme.rst

+84-19
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,37 @@
11
Blender Substance Texture Importer
22
------------------------------------
33

4-
Doc and screenshots outdated !!!
54

6-
.. figure:: http://kos-design.com/images/plugthum.cropped.png
5+
.. figure:: http://kos-design.com/images/wikipics/bsti_panel.jpg
76
:scale: 100 %
87
:align: center
98

10-
-----------
9+
1110
Description:
12-
-----------
11+
------------
1312

14-
Blender addon designed to import Substance Painter Textures and other similar P.B.R maps into Blender 3D easily. The script imports the texture maps from the choosen folder and assigns them to the selected objects according to their material name.
15-
The texture maps exported from Substance Painter or similar tools usually have a name pattern containing the material name a prefix(object name) and the texture map name (BaseColor, Metallic, Roughness, Normal etc.).
16-
The script attempts to guess the name pattern from the texture folder content and assigns the relevant texture maps to the Shaders of the selected objects. (Manual assignment is also possible for special cases)
13+
Blender addon designed to import images textures made with Substance Painter or other similar surfacing tools into Blender 3D easily.
14+
The script looks at all the images in the choosen directory and attempts to guess the corresponding shader input to plug them into.
15+
Basing its detection on the objects materials names, the algorithm will look for a matching image file depending on the selected map types enabled in the UI panel (available in the Material Properties section ).
16+
The texture maps names are editable and the target shader input socket can be set from a dropdown list for better control.
17+
The texture files must have been exported using a pattern containing the material name and a map type (BaseColor, Metallic, Roughness, Normal etc.).
18+
Manual assignement is also possible for a given material regardless of the texture file name pattern.
19+
Various options are available for fine tuning such as adding RGB curves and color ramps, using custom shader nodes or even ignoring the .00x prefix in duplicated material names.
1720

18-
Lets say the selected texture folder contains a set of P.B.R. texture maps named “prefix_FirstMaterialName_BaseColor.png”, “prefix_FirstMaterialName_Roughness.png”, “prefix_FirstMaterialName_Metallic.exr”, “prefix_SecondMaterialName_BaseColor.png” etc.
19-
(or another kind of name pattern containing a Material name and a Texture map name)
20-
You only need to activate the relevant line in the addon panel (and edit the texture map name if needed) to batch import the image textures into their associated shaders on all selected objects at once.
2121

2222
Installation:
23-
---------------
23+
-------------
2424

2525
`TLDR Add-on Installation Video Tutorial <https://youtu.be/lumrnhikSOg>`__
2626

2727
https://youtu.be/lumrnhikSOg
2828

29-
Download the git release from https://github.com/Kos-Design/materials_substance/releases/download/0.2.4/Blender_Substance_Texture_Importer.zip
29+
Download the git release from here (LINK_TO_LATEST_RELEASE)
3030
and install it in Blender via Edit > Preferences > Add-ons > Install an Addon
31-
Note : if you download the files manually from git, place them ( __init__.py, Operators.py, Panels.py and PropertyGroups.py ) in a folder called "materials_substance" inside your Blender Add-Ons directory.
32-
It will appear in the Add-Ons list, enable it by ticking the checkbox in front of “Material: Blender Substance Texture Importer”
33-
That’s it the plugin is ready to use.
31+
Note : if you download the files manually copy the folder inside your Blender Add-Ons directory.
32+
It will then appear in the Add-Ons list (you can find it by typing "Material: Blender Substance Texture Importer" in the search bar of the Blender Preferences window > Addon tab).
33+
Enable like the other add-ons by ticking the checkbox in front of “Material: Blender Substance Texture Importer”.
34+
The user interface panel is available from the Material section in the Properties window.
3435

3536

3637
How-to:
@@ -40,13 +41,77 @@ How-to:
4041

4142
https://youtu.be/45rky8J_0us
4243

43-
`Documentation <doc/Home.md>`__
44+
`Wiki <doc/Home.md>`__
4445
(still in progress)
4546

46-
A Panel labeled Substance Texture Importer is displayed under the Shader Settings in the Material Tab.
47+
The panel labeled "Substance Texture Importer" is displayed under the Shader Settings in the Material Tab.
48+
49+
First choose the directory containing the textures files to be imported.
50+
(IMG FOLDERSELECT)
51+
After setting the folder the script should automatically detect and activate the relevant maps in the panel.
52+
You can enable/disable the textures maps type you wish to import by checking the corresponding line in the addon panel (and edit the texture map name if needed)
53+
If a matching texture fils is detected the icon next to the map name should change from a question mark to a checked icon (IMAGE Question mark & Checked icons)
54+
Then you can use the "Import Textures" button to batch import the images into their associated shaders sockets.
55+
Or use the "Setup nodes" button below to only create empty image nodes, and the use the "Assign images" button to fill the images nodes with the matching textures files.
56+
By default the script will import the images for all selected objects at once, there are also some options to import them for all visible objects, only the active object or only the active material of each selected object.
57+
58+
59+
Options:
60+
--------
61+
62+
---------------
63+
Replace Shader:
64+
---------------
65+
When this option is enabled the shader node of the material will be replaced by the one displayed in the dropdown selector next to it.
66+
67+
-----------------------------
68+
Apply to all visible objects:
69+
-----------------------------
70+
Process all visible objects regardless of the current selection.
71+
72+
----------------------------
73+
Apply to active object only:
74+
----------------------------
75+
Process only the last selected / active object regardless of the current selection.
76+
77+
--------------------------
78+
Skip normal map detection:
79+
--------------------------
80+
By default a normal map node or bump map node is added when a normal map or height map is detected. Enable this option if you are using a custom shader that already include such conversion node in order to plug the image directly in the selected input socket.
81+
82+
----------------------
83+
Enable Custom Shaders:
84+
----------------------
85+
Use this option to add your own NodeGroups to the Shaders list used by the "Replace Shaders" option.
86+
Your custom shaders needs to have at least one input socket and a shader output socket in order to be added to the list.
87+
88+
--------------------------
89+
Clear nodes from material:
90+
--------------------------
91+
Removes all existing nodes nodes from the target materials before processing them.
92+
93+
---------------------
94+
Only active material:
95+
---------------------
96+
Process only the active material from the material slots for each target object.
97+
98+
----------------------------------
99+
Duplicated material compatibility:
100+
----------------------------------
101+
Enable this option to ignore the .00x prefix from the target materials names.
102+
103+
------------
104+
Manual Mode:
105+
------------
106+
Use this to be able to manually select a texture file instead of relying on the pattern detection algorithm of the addon.
107+
When enabled the icon next to the map name on each panel line will change to (ICON).
108+
You can then activate it for each line and the texture map name will change to an individual file selection field.
109+
110+
111+
Presets:
112+
--------
113+
The icon (ICON) in the top-right corner allows you to store and loads the parameters used in the UI panel.
47114

48-
First choose the Directory containing the Texture Maps to be imported.
49-
(It is best to keep the texture images in a separate folder to help the script images name detection.)
50115

51116
License
52117
-------

0 commit comments

Comments
 (0)