YannK/Textures_factory
YannK/Textures_factory
1
0
Fork 0
Code Issues 2 Pull requests Actions Packages Projects Releases Wiki Activity

Adding explanations about configuration variables - Cleaning the Makefile accordingly

Browse source
This commit is contained in:
yannk 2021-12-15 22:15:57 +01:00
parent 676a2494a7
commit ec52ff1f7d
2 changed files with 53 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Makefile
View file

@ -10,6 +10,7 @@ export SBSRENDER=sbsrender
# sbsar files generation part
export SBS_DIR=sbs
export SBSAR_DIR=sbsar
## Auto definitions - do not change
export SBSFILES = $(wildcard $(SBS_DIR)/*.sbs)
export SBSARDESTINATION = $(subst $(SBS_DIR)/, $(SBSAR_DIR)/, $(SBSFILES))
export SBSARFILES = $(SBSARDESTINATION:.sbs=.sbsar)
@ -17,7 +18,7 @@ export SBSARFILES = $(SBSARDESTINATION:.sbs=.sbsar)
# texturesets files
export TEXTURESET_FOLDER := texturesets
# png files folders - Veiller à changer dans le script create_pngsets_makefile.sh également si besoin
# png files folders
export PNG1024_DIR := png_1024
export PNG512_DIR := png_512
export PNG256_DIR := png_256
@ -29,12 +30,15 @@ export BLENDEREXEC := /home/yann/Documents/3D/blender_builds/daily/blender-3.1.0
# Logo file
export LOGO := logo/YKtextures.png
# Destination folder
# Destination preview folder
export BUILD_FOLDER := build
# Material list
export MATERIALLIST := material_list.json
### RECIPE PART ###
all : previews subformats
previews: $(SBSARFILES)

47
README.md Normal file
View file

@ -0,0 +1,47 @@
# Factory to handle Substance files to distribute content
## Organisation of a factory
### Configuration of the Makefile
The beginning of the Makefile contains all the variables and configuration needed.
# Variables definitions
The very first one shouldn’t be changed, as it will check the proper shell is used to execute the script.
## 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. It must be indicated in the corresponding place there. Simply write either the absolute or the relative path from your Makefile script situation for the `SBS_DIR` variables content.
You must write down also the place where the script will write the generated sbsar.
## Texturesets files
You can leave the folder indicated here, as it will be used only internally by the script to check the texturesets it handles.
## 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.