This page explains the conventions for file names that we both use for development and teach all of our students , for the sake of order and compatibility between each-other. All staff should reference and promote this.(mentors: not necessarily in the early lessons, but at least at some later point).
Code Conventions in other page: https://gameready.co.il/code-conventionsAssets (files) Names:
overall format:
objectName_optionalDetails_whatIsIt.format
note: (Except for BP classes files, which start with CapitalLetter. more on that in https://gameready.co.il/code-conventions/)
examples:
- combatKnife_mesh.fbx //both skeletal and static
- CombatKnife //BP class asset
- combatKnife_D.png //diffuse
- combatKnife_A.png //albedo combatKnife_N.png //normal map
- combatKnife_R.png //roughness
- combatKnife_M.png //metallic
- combatKnife_O.png //ambient occlusion
- combatKnife_RMO.png //Red:roughness + Green:metallic Blue:AO different arrangements of R,M,O letters if needed to represent R,G,B
- combatKnife_H.png //height
- combatKnife_mask.png //any kind of mask
- combatKnife_Mat //material
- combatKnife_MatInst //material instance
- shoe_left_mesh.fbx
- shoe_right_mesh.fbx
- standing_idle_anim.fbx
important:
sections are sepperated by “_” (underscore). each section starts with non-capital leter. multi-word sections:Examples:must be camelcase (withFirstLeterLowAndEveryOtherWordStartingWithCapitalLeter)ar15_receiver_m4a1 ar15_receiver_m16 ar15_handle_std ar15_handle_magpul ar15_handguard_triangle_long ar15_handguard_triangle_short ar15_handguard_tube_long ar15_barrel_short ar15_barrel_medium ar15_muzzle_std ar15_stock_whole ar15_stock_ext
Folders:
Naming:
(1) non-leaf folders (with other folders inside) starts with capital letter. (2) leaf folders (with user content inside) starts with non capital letter.
UE4 folder colors:
purple: classes, blueprints blue: macros, data structures green: terrain, foliage… yellow: art assets of any kind red: to get rid off / scrap useful stuff then delete