Editing Repository Reference/Naming conventions
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
{{navigation title|Building a Game}} | {{navigation title|Building a Game}} | ||
| − | |||
Naming conventions are required to keep repository clean and easy to work with. There is some files violating common rules, making them first candidates for the renaming. | Naming conventions are required to keep repository clean and easy to work with. There is some files violating common rules, making them first candidates for the renaming. | ||
| − | |||
| − | |||
==Texture names== | ==Texture names== | ||
| − | Texture name should | + | Texture name should contain only latin characters, all lowercase. It should have one or two words explaining what this texture is for. Special texture should be suffixed according to skinframe rules (see [[texture]]) |
| − | + | ||
| − | Special | + | |
| − | + | If there is several variations of this texture, use the following template for naming: '''texturename<group_number>_<texture_number>''' | |
| − | + | ||
Example: | Example: | ||
| Line 21: | Line 15: | ||
textures/towns/brick2_3 | textures/towns/brick2_3 | ||
textures/towns/brick3_1 | textures/towns/brick3_1 | ||
| − | |||
==Material names== | ==Material names== | ||
Material names should mimic texture names where possible. For portability reasons there should be only forward ('''/''') slashes. | Material names should mimic texture names where possible. For portability reasons there should be only forward ('''/''') slashes. | ||
| Line 30: | Line 23: | ||
textures/inn/window <font color=green>// base material</font> | textures/inn/window <font color=green>// base material</font> | ||
textures/inn/window_envmap <font color=green>// additional envmap layer</font> | textures/inn/window_envmap <font color=green>// additional envmap layer</font> | ||
| + | |||
| + | {{tip|Material layers are done with copying a mesh in a model, or with q3map_cloneShader material keyword (this only works for map surfaces)}} | ||
==Texture themes== | ==Texture themes== | ||
| − | Texture themes is way to categorize textures in map editor. Only one texture theme | + | Texture themes is way to categorize textures in map editor. Only one texture theme are seen in level editor texture browser. Also it is convenient way to break files into several separate folders. |
Texture theme should be one word explaining what it will be (like crypt, mausoleum, inn etc.). | Texture theme should be one word explaining what it will be (like crypt, mausoleum, inn etc.). | ||
| Line 60: | Line 55: | ||
==Model themes== | ==Model themes== | ||
| − | Like texture themes, model themes are subfolders in | + | Like texture themes, model themes are subfolders in models/mapobjects/. Model theme name should be one word, explaining what models will be used for. |
Examples: | Examples: | ||
| Line 68: | Line 63: | ||
==Map names== | ==Map names== | ||
| − | Map name | + | Map name should contain lowercase latin characters and position of a map in hierarchy: |
* '''World''' | * '''World''' | ||
| − | ** ''' | + | ** '''Locations''' |
| − | *** '''Sub- | + | *** '''Sub-locations''' |
| − | + | Template: '''w'''[''worldnum'']'''m'''[''locationnum'']'''''-'''''[''location_name'']'''-'''[''sub-location_name''] | |
| − | :w'' | + | |
| − | If sub-location is grouped (there is several crypts, caves etc.) first one | + | If sub-location is grouped (there is several crypts, caves etc.) first one doesnt contain 1 in the end. |
Examples: | Examples: | ||
| Line 81: | Line 75: | ||
w1m2-pillars-crypt | w1m2-pillars-crypt | ||
w1m2-pillars-crypt2 | w1m2-pillars-crypt2 | ||
| − | + | Test levels should be prefixed by '''test-'''. They are not added to game release build. | |
| − | Test levels | + | |
==Map props== | ==Map props== | ||
| Line 95: | Line 88: | ||
'''terr01b.ASE''' | '''terr01b.ASE''' | ||
| − | {{navigation footer| | + | {{navigation footer|Repository structure in-depth}} |
| − | + | ||
