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}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==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 13: | ||
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 ( | + | Material names should mimic texture names where possible. For portability reasons there should be only forward slashes (/). |
| − | If material is additional variation of a base | + | If material is additional variation of a base materia, or additional layer of it, it's name should begin as it's base material |
Example: | Example: | ||
| Line 32: | Line 23: | ||
==Texture themes== | ==Texture themes== | ||
| − | + | For convenience materials is grouped into different themes, each theme is subfolder of textures/ and separate list item in texture window of map editor. | |
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.). | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Model names== | ==Model names== | ||
Model names can contain lowercase latin characters, numbers and underscore as spacer. Names should be sane, suffixes and numbers should be added only if model is part of some group. | Model names can contain lowercase latin characters, numbers and underscore as spacer. Names should be sane, suffixes and numbers should be added only if model is part of some group. | ||
| Line 49: | Line 32: | ||
Examples: | Examples: | ||
| − | |||
models/mapobjects/graveyard/stone1.md3 | models/mapobjects/graveyard/stone1.md3 | ||
models/mapobjects/graveyard/stone2.md3 | models/mapobjects/graveyard/stone2.md3 | ||
| Line 55: | Line 37: | ||
models/mapobjects/misc/bat1.md3 | models/mapobjects/misc/bat1.md3 | ||
models/mapobjects/misc/bat2.md3 | models/mapobjects/misc/bat2.md3 | ||
| − | |||
| − | |||
| − | |||
| − | |||
==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 66: | Line 44: | ||
dungeon | dungeon | ||
graveyard | graveyard | ||
| − | |||
==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 57: | ||
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== | ||
| − | All level | + | All level pros is saved to models/maps/<location_name> folders. Yet again, use same names. For example, name terrain mesh as '''terrain.ase''', not '''02.ase''' or '''terr01b.ase'''. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | {{navigation footer| | + | {{navigation footer|Repository structure in-depth}} |
| − | + | ||
