3D Asset Workflow: Naming the Asset - Revision history

Mio Mäkijärvi at 06:21, 4 September 2023

2023-09-04T06:21:01Z

← Older revision		Revision as of 09:21, 4 September 2023
Line 1:		Line 1:
	<div style="border-bottom:2px solid #99aac7; background:#d0def5; padding:0.4em 0.5em; font-size:130%; margin-bottom: 25px; text-align: center; float:top;">		<div style="border-bottom:2px solid #99aac7; background:#d0def5; padding:0.4em 0.5em; font-size:130%; margin-bottom: 25px; text-align: center; float:top;">
	⬑ [[3D Asset Workflow]]</div>		⬑ [[3D Asset Workflow]]</div>
			<div style="border-bottom:2px solid #99aac7; background:#d0def5; padding:0.4em 0.5em; font-size:130%; float:right; margin-bottom: 25px;">
			Next step: [[3D Asset Workflow: LODs]] →</div>
			<div style="border-bottom:2px solid #99aac7; background:#d0def5; padding:0.4em 0.5em; font-size:130%; float:left; margin-bottom: 25px;">
			← Previous step: [[3D Asset Workflow: Asset Assembling]]</div>


	<div style="padding-right: 10px; padding-left: 1000px; padding-top: 60px; padding-bottom: 80px;">		<div style="padding-right: 10px; padding-left: 1000px; padding-top: 60px; padding-bottom: 80px;">
	{{#lst:3D Asset Workflow}} <!-- Link list transcluded from main 3D Asset Workflow page -->		{{#lst:3D Asset Workflow}} <!-- Link list transcluded from main 3D Asset Workflow page -->
	</div>		</div>


	= Summary =		= Summary =

Mio Mäkijärvi: /* Naming Conventions for Textures */

2023-08-01T07:17:22Z

Naming Conventions for Textures

← Older revision		Revision as of 10:17, 1 August 2023
Line 137:		Line 137:
	\| _fm		\| _fm
	\| sample_asset_mat<span style="background:lightgrey; padding:5px;">_fm</span>.tga		\| sample_asset_mat<span style="background:lightgrey; padding:5px;">_fm</span>.tga
	\| ~~[[3D Asset Workflow: Flowmaps]]~~		\|
	\|-		\|-
	\| ''Detail Albedo''		\| ''Detail Albedo''
	\| _da		\| _da
	\| [material]_[clarifying adjective]<span style="background:lightgrey; padding:5px;">_da</span>.tga		\| [material]_[clarifying adjective]<span style="background:lightgrey; padding:5px;">_da</span>.tga
	\| ~~[[3D Asset Workflow: Detail Textures]]~~		\|
	\|-		\|-
	\| ''Detail Normal''		\| ''Detail Normal''
	\| _dn		\| _dn
	\| [material]_[clarifying adjective]<span style="background:lightgrey; padding:5px;">_dn</span>.tga		\| [material]_[clarifying adjective]<span style="background:lightgrey; padding:5px;">_dn</span>.tga
	\| ~~[[3D Asset Workflow: Detail Textures]]~~		\|
	\|-		\|-
	\|}		\|}

Mio Mäkijärvi at 13:41, 28 July 2023

2023-07-28T13:41:26Z

← Older revision		Revision as of 16:41, 28 July 2023
Line 1:		Line 1:
			<div style="border-bottom:2px solid #99aac7; background:#d0def5; padding:0.4em 0.5em; font-size:130%; margin-bottom: 25px; text-align: center; float:top;">
			⬑ [[3D Asset Workflow]]</div>

			<div style="padding-right: 10px; padding-left: 1000px; padding-top: 60px; padding-bottom: 80px;">
			{{#lst:3D Asset Workflow}} <!-- Link list transcluded from main 3D Asset Workflow page -->
			</div>

	= Summary =		= Summary =
	* From this page, you can find instructions of:		* From this page, you can find instructions of:

Mio Mäkijärvi: /* Building the hierarchical name */

2023-07-28T12:27:36Z

Building the hierarchical name

← Older revision		Revision as of 15:27, 28 July 2023
Line 60:		Line 60:
	** <span style="background:plum; padding:5px;">'''blockset'''</span>_<span style="background:gold; padding:5px;">'''observatory'''</span>_<span style="background:LightGreen; padding:5px;">'''pillar'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''10m'''</span>_<span style="background:Pink; padding:5px;">'''1'''</span>		** <span style="background:plum; padding:5px;">'''blockset'''</span>_<span style="background:gold; padding:5px;">'''observatory'''</span>_<span style="background:LightGreen; padding:5px;">'''pillar'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''10m'''</span>_<span style="background:Pink; padding:5px;">'''1'''</span>
	** <span style="background:plum; padding:5px;">'''blockset'''</span>_<span style="background:gold; padding:5px;">'''mountain'''</span>_<span style="background:LightGreen; padding:5px;">'''bg'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''flattop'''</span>		** <span style="background:plum; padding:5px;">'''blockset'''</span>_<span style="background:gold; padding:5px;">'''mountain'''</span>_<span style="background:LightGreen; padding:5px;">'''bg'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''flattop'''</span>
	** <span style="background:plum; padding:5px;">'''blockset'''</span>_<span style="background:gold; padding:5px;">'''beam'''</span>_<span style="background:LightGreen; padding:5px;">'''wooden'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''2m'''</span>_<span style="background:Pink; padding:5px;">'''2'''~~</span>_~~</span>_<span style="background:LightCoral; padding:5px;">'''45d'''</span>		** <span style="background:plum; padding:5px;">'''blockset'''</span>_<span style="background:gold; padding:5px;">'''beam'''</span>_<span style="background:LightGreen; padding:5px;">'''wooden'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''2m'''</span>_<span style="background:Pink; padding:5px;">'''2'''</span>_<span style="background:LightCoral; padding:5px;">'''45d'''</span>
	** <span style="background:plum; padding:5px;">'''vegetation'''</span>_<span style="background:gold; padding:5px;">'''tree'''</span>_<span style="background:LightGreen; padding:5px;">'''maple'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''s'''</span>_<span style="background:Pink; padding:5px;">'''3'''</span>		** <span style="background:plum; padding:5px;">'''vegetation'''</span>_<span style="background:gold; padding:5px;">'''tree'''</span>_<span style="background:LightGreen; padding:5px;">'''maple'''</span>_<span style="background:PaleTurquoise; padding:5px;">'''s'''</span>_<span style="background:Pink; padding:5px;">'''3'''</span>
	** <span style="background:plum; padding:5px;">'''gameplay'''</span>_<span style="background:gold; padding:5px;">'''ball'''</span>_<span style="background:LightGreen; padding:5px;">'''cabbage'''</span>		** <span style="background:plum; padding:5px;">'''gameplay'''</span>_<span style="background:gold; padding:5px;">'''ball'''</span>_<span style="background:LightGreen; padding:5px;">'''cabbage'''</span>

Mio Mäkijärvi: Created page with "= Summary = * From this page, you can find instructions of: # '''How to name your asset''' so it's naming stays consistent with the rest of the Trine 3D assets #* 3D_Asset_W..."

2023-07-28T12:26:52Z

Created page with "= Summary = * From this page, you can find instructions of: # '''How to name your asset''' so it's naming stays consistent with the rest of the Trine 3D assets #* 3D_Asset_W..."

New page

= Summary =
* From this page, you can find instructions of:
# '''How to name your asset''' so it's naming stays consistent with the rest of the Trine 3D assets
#* [[3D_Asset_Workflow:_Naming_the_Asset#Naming_Conventions_for_Textures|How to name your textures]]
# '''Where in the binary to put your asset and its' texture maps''', so they're easily found
#* And, thus, '''how to name the folder the asset should be in, if one doesn't exist yet'''
#** [[3D_Asset_Workflow:_Naming_the_Asset#Can.27t_find_a_folder_for_your_asset.3F|Can't find a folder for your asset?]]

== Naming Instructions ==
# '''The asset's name is determined by it's intended location in the SVN folder hierarchy'''
#* As a general rule, '''start from the root of the hierarchy, and build your way towards top'''
#** Look at the '''folder names''' from the path the asset will be added to, and '''use those when naming the asset'''
#*** As an exception to the rule, note that the blockset type (building/natural) should be left out, to reduce bloating
#* The SVN folder hierarchy is created to support easier locating for all related 3D assets
# '''Every 3D asset should have at least a general name and a more clarifying name, in this order'''
#* In other words: "gameplay_barrel" or "prop_market_barrel", not just "barrel"
# '''No capital letters'''
# '''No spaces, use "_" instead'''
# '''Double check your spelling!'''
# [[3D_Asset_Workflow:_Naming_the_Asset#Naming_Conventions_for_Textures|All texture maps should be named with the same name than the 3D asset]], '''plus a "_mat" suffix'''

== Building the hierarchical name ==
* There can be more clarifying names that listed here, as long as they go '''from more generic to more specified ones'''
* Note that the blockset type (building/natural) should be left out, to reduce bloating
 
# '''[Category]'''
#* What is the category of the asset:
## blockset (building / natural / general - note that these subcategories are left out of the final naming!)
## prop
## gameplay asset
## vegetation
## atmosphere
# '''[General]'''
#* Intended general use within the category:
#** What kind of a blockset - library, castle, observatory, mountain, a type of terrain (like field, soil, snow etc)?
#** What kind of a general blockset - beam, platform etc?
#** What kind of a prop - furniture, textile, light etc?
#*** Or where the prop is supposed to be used - library, observatory, farm etc?
#** What kind of vegetation - plant, flower, tree, mushroom etc?
#** What kind of a gameplay asset - ball, pressureplate, chest etc?
# '''[Clarify]'''
#* Clarify the use withing the general use:
#** What kind of a manmade blockset part - house, tower, wall, pillar, roof etc?
#** What kind of a mountain - snowy, jagged, smooth?
#** What kind of a specific e.g. tree - maple, spruce etc?
#** If this is a background/billboard version of an asset, add the "bg"/"billboard" clarification here
# '''[Clarify more]'''
#* Clarify even more by e.g. size or shape - s/m/l (small/medium/large), 10m/5m/2m, straight/crooked etc
#* There can be additional clarifications, as long as they go '''from more generic to more specified ones'''
#* Add first letters only for sizes small/medium/large = s/m/l
# '''[Number]'''
#* If there are multiple versions of the same asset, use numbers at the end of the name to separate them from each other
#* '''Usually here shouldn't be need for more than three versions of the same asset'''
#* The number isn't necessary and can be left out if there's only one version
# '''[Angle]'''
#* If your asset has set angles, they should be added as a last suffix
#* Use number+d, e.g. 45d, 90d

* Final name examples:
** '''blockset'''_'''observatory'''_'''pillar'''_'''10m'''_'''1'''
** '''blockset'''_'''mountain'''_'''bg'''_'''flattop'''
** '''blockset'''_'''beam'''_'''wooden'''_'''2m'''_'''2'''__'''45d'''
** '''vegetation'''_'''tree'''_'''maple'''_'''s'''_'''3'''
** '''gameplay'''_'''ball'''_'''cabbage'''

== Can't find a folder for your asset? ==
* If there isn't an existing folder in the project's SVN that fits your 3D asset, you can make one yourself
* Make sure that:
# '''The folder is created to the correct place and depth in the hierarchy'''
#* If your asset is e.g. ballridable cabbage, it should go under ".../gameplay/ball/cabbage", because it's A) a gameplay asset, B) ball-shaped and acts like a ball in all manners that matter, and C) a cabbage
#* This is to ensure that no root folders will get bloated unnecessarily
# '''The naming of the folder matches the existing names'''

* '''Note that it's not advised to move and/or rename assets once they're in the game!'''
** Moving and/or renaming assets that are already in use will break them, because in the Editor, ''moving/renaming an asset means first deleting it, and then re-adding it''
*** In practice, this means that the Editor views it as a new asset entirely, and won't know how to relink the existing, delete asset to the new one

= Naming Conventions for Textures =
* [[3D Asset Workflow: Texturing]]
* '''Always remember to compress your textures when saving them as targa'''

{| class="wikitable"
|-
! Map type
! Suffix
! Example
! Notes
|-
| '''Albedo'''
|
| sample_asset_mat.tga
| Basic color map
|-
|
| _at_
| sample_asset_mat_at.tga
| Alpha test- Binary black&white transparency map in alpha channel. Suffix goes after filename and before other suffixes. '''Needs to be a 32bit Targa'''
|-
|
| _ab_
| sample_asset_mat _ab.tga
| Alpha blend. Grayscale transparency map in alpha channel. Suffix goes after filename and before other suffixes. '''Needs to be a 32bit Targa'''
|-
| '''Normal'''
| _n
| sample_asset_mat_n.tga
| RGB vector map describing surface orientation per pixel
|-
| '''Metallic/Roughness'''
| _mr
| sample_asset_mat_mr.tga
| Channel packed map containing metallic in the red channel and roughness in the green channel
|-
| '''Illumination/emissive'''
| _e
| sample_asset_mat_e.tga
| Self illumination map
|-
| ''Wrap''
| _w
| sample_asset_mat_w.tga
| Thickness map to determine how much light passes through e.g. a leaf
|-
| ''Tint mask''
| _tintmask
| sample_asset_mat_tintmask.tga
| RGB mask for color tinting. More info on usage in [[3D Asset Workflow: Tintmask]]
|-
| ''Flowmap''
| _fm
| sample_asset_mat_fm.tga
| [[3D Asset Workflow: Flowmaps]]
|-
| ''Detail Albedo''
| _da
| [material]_[clarifying adjective]_da.tga
| [[3D Asset Workflow: Detail Textures]]
|-
| ''Detail Normal''
| _dn
| [material]_[clarifying adjective]_dn.tga
| [[3D Asset Workflow: Detail Textures]]
|-
|}