Textures_factory/README.md

# Factory to handle Substance files to distribute content

This repository use [Git LFS](https://git-lfs.github.com/).

## Organisation of a factory

### Configuration of the Makefile

The file `global-config.mk` contain configuration informations about paths to sources, executables and to the building destinations. It details all the variables which can be set but shouldn’t be modified, as it can receive new variables in the future needed for the script to work. Moreover is handled by git for new versions and any changes you make would be erased by new pull of the script. If you want to specify a dedicated value to any variable, you should copy its line definition to a new file inf the same folder, called `local-config.mk`. Like this, you will keep your local configuration files in the future with new versions of the script.

Simply write either the absolute or the relative path from your Makefile script situation for any information needed.

## Executables used

These are the adress of the substance automation toolkit binaries.

## Sbsar files generation part

You need to define a sbs source folder where the script will check for new content in the `SBS_DIR` variables content.

You must write down also the place where the script will write the generated sbsar.

## Texturesets files

This files will be used only internally by the script to check the texturesets it handles.

# Texture names possible

This variable is needed to recognize the files created as bitmaps from the substance source, it must include all the identifiers used in all the graphs, separated by a pipe and no space. It is used as regexp rule in the script.

## Png files folders

Theses are the places where the script will generate the final png files. It will be the main repository used as reference to fill hereafter all the targets needed in any package needed.

## Blender related

You have to define also a blender file directory where you will store the files used to generate previews of texturesets. They will be handled vie the `material_list.json` file indicated in the following section. They will have to be organized a special way to function, see later.

The `BLENDEREXEC` variable is the path to the binary used to generate the preview. It must be compatible with the version used to save the renders files.

## Logo file

Indicate any logo you would need as watermark in any of the content.

# Destination preview folder

Where you will save the renders of the previews of each textureset generated by Blender.

# Material list

The path to the json file used to manage all the metadata linked to texturesets and proper management of the content generated by the script. It must comply to a specific organisation and content to work properly.
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
+								# Factory to handle Substance files to distribute content
-												Adding Indications about the use of Git LFS for big binary files

											
										
										
											2021-12-15 21:26:23 +00:00
+								This repository use [Git LFS](https://git-lfs.github.com/).
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
+								## Organisation of a factory
 								### Configuration of the Makefile
-												Fixing typo - Close #2

											
										
										
											2021-12-17 22:14:16 +00:00
+								The file `global-config.mk` contain configuration informations about paths to sources, executables and to the building destinations. It details all the variables which can be set but shouldn’t be modified, as it can receive new variables in the future needed for the script to work. Moreover is handled by git for new versions and any changes you make would be erased by new pull of the script. If you want to specify a dedicated value to any variable, you should copy its line definition to a new file inf the same folder, called `local-config.mk`. Like this, you will keep your local configuration files in the future with new versions of the script.
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
-												Adding informations about config files

											
										
										
											2021-12-17 21:52:29 +00:00
+								Simply write either the absolute or the relative path from your Makefile script situation for any information needed.
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
 								## Executables used
 								These are the adress of the substance automation toolkit binaries.
 								## Sbsar files generation part
-												Adding informations about config files

											
										
										
											2021-12-17 21:52:29 +00:00
+								You need to define a sbs source folder where the script will check for new content in the `SBS_DIR` variables content.
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
 								You must write down also the place where the script will write the generated sbsar.
 								## Texturesets files
-												Adding informations about config files

											
										
										
											2021-12-17 21:52:29 +00:00
+								This files will be used only internally by the script to check the texturesets it handles.
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
-												Add a variable to recognize identifiers of outputs from graphs, letting people choose any preset and file name they want as long as they indicate there the existing identifiers

											
										
										
											2021-12-15 22:20:51 +00:00
+								# Texture names possible
 								This variable is needed to recognize the files created as bitmaps from the substance source, it must include all the identifiers used in all the graphs, separated by a pipe and no space. It is used as regexp rule in the script.
-												Adding explanations about configuration variables - Cleaning the Makefile accordingly

											
										
										
											2021-12-15 21:15:57 +00:00
+								## Png files folders
 								Theses are the places where the script will generate the final png files. It will be the main repository used as reference to fill hereafter all the targets needed in any package needed.
 								## Blender related
 								You have to define also a blender file directory where you will store the files used to generate previews of texturesets. They will be handled vie the `material_list.json` file indicated in the following section. They will have to be organized a special way to function, see later.
 								The `BLENDEREXEC` variable is the path to the binary used to generate the preview. It must be compatible with the version used to save the renders files.
 								## Logo file
 								Indicate any logo you would need as watermark in any of the content.
 								# Destination preview folder
 								Where you will save the renders of the previews of each textureset generated by Blender.
 								# Material list
 								The path to the json file used to manage all the metadata linked to texturesets and proper management of the content generated by the script. It must comply to a specific organisation and content to work properly.