Naming conventions/ru

From Dragon Age Toolset Wiki
< Naming conventions
Revision as of 03:43, 1 December 2011 by Kelamor (Talk | contribs) (Edit)

Jump to: navigation, search
Соглашение об именах
Начало / Русская DA Builder Wiki / Поделиться ВКонтакте

Для своих ресурсов, Bioware'цы следовали определённому соглашению об именах, что дало им лёгкое управление ресурсами и их поиск. Когда вы задумаетесь о необходимости создания оригинальных ресурсов для своих модификаций будет неплохим решением следовать этому соглашению. Либо же модифицировать его под свои нужды, например в наименовании каждого ресурса добавлять префикс в виде сокращения от названия вашего модуля, что позволить вам легко идентифицировать ваши ресурсы и создать упорядоченную структуру.

Обычно наименование ресурса формируется с использованием префикса, наименования и суффикса, разделённых подчёркиванием, что позволяет выделить различные категории ресурсов (например по типу), их принадлежность к чему-либо (например к локации).

По большей части, конечно, наименование ваших ресурсов будет иметь значение только для вас, тулсет же вряд ли обратит внимание на наименование ресурса. Хотя во избежание различных конфликтов лучше следовать парочке правил:

  • Использование в именах ресурсов только латиницу, да тулсет вам и не даст наименовать ресурс кириллическими символами.
  • Уникальные имёна. Если имеется два ресурса с одинаковым именем, то загружаться будет только один, причём выбор будет сделан согласно приоритету папок (en).
  • Не применяйте префиксы, используемые Bioware'цами, например "gen".

Соглашение об именах ресурсов

Ресурсы базы данных именуются в свободной форме. Однако, исходя из удобства и вежливости по отношении к игрокам и другим разработчикам, желательно следовать соглашению. Это уменьшит риск возникновения конфликтов между модулями разных авторов и улучшит совместимость с будущими версиями игры от Bioware. Также не забывайте, что только один ресурс с заданным именем будет загружен в игру.

Для простых модификаций вполне достаточно будет использовать уникальный префикс (en) в имени ресурса, который вряд ли будет использован кем-либо еще.

При создании крупных модификаций предпочтительнее использовать более профессиональный подход, с использованием префиксов и суффиксов, что позволит, помимо вышеперечисленного, сделать более удобным написание скриптов.

Конвенции, используемые в основной кампании для одного игрока из игры Dragon Age выглядит следующим образом:

Разберём следующее наименование ресурса из Основной компании (модуль "Single Player"): 

cir200cr_bloodmage
  • Три буквы префикса указывают на область игры, в которой используется ресурс, (отдельная история происхождения, прелюдия и т.д.) или "ген" для глобальных ресурсов.
  • трехзначный номер, присваиваемый конкретной области, в целом, начиная с 100 и увеличивая в сотнях для крупных районов. Полезная площадь даны номера в пределах блока из ста, что их "родитель" область принадлежит. "глобальных" ресурсов часто получают номер 000.
  • двухбуквенный код, указывающий на то, что общий тип ресурсов это ("АР" для области, "аль" для области списка, "IP" для перемещаемая, "кр" по существу ", им" на пункт "TR" для запуска , "р" для сюжета, "ST": на сцене, "CS" для заставки "РГ" в точку).Основным исключением здесь является событием скрипты, которые имеют точно такое же имя, ресурс они сценария. Диалог файлы также в целом назван в точности такой же, как их владельца ресурса. Торговцы, как правило, имя владельца, с приставкой "store_".
  • Подчеркивания.
  • Оставшуюся часть имени в свободной форме и человеческого понимания, описательный термин, чтобы напомнить вам с первого взгляда, что ресурс.
  • Three-letter prefix indicating which large-scale area of the game the resource begins to (particular origin story, prelude, etc) or "gen" for global resources.
  • three-digit number unique to a particular area, generally starting with 100 and incrementing in hundreds for major areas. Accessory areas are given numbers within the block of one hundred that their 'parent' area belongs to. "global" resources are often given the number 000.
  • two-letter code indicating what general type of resource it is ("ar" for area, "al" for area list, "ip" for placeable, "cr" for creature, "im" for item, "tr" for trigger, "pt" for plot, "st" for stage, "cs" for cutscene, "wp" for waypoint). A major exception here is event scripts, which have exactly the same name as the resource they're the script for. Dialogue files are also generally named exactly the same as their owner resource. Merchants usually have the owner name, with the prefix "store_".
  • An underscore.
  • The remainder of the name is free-form and human-readable, a descriptive term to remind you at a glance what the resource is.

Model File Naming Convention

Items

[MainClass]_[MODELTYPE]_[MODELSUBTYPE][MODELVARIATION]_[LOD].MMH / PHY 

[ef]_[rob]_[enc][a]_[0].mmh  (ef_rob_enca_0.mmh)
  • Where [MainClass] is of General type of a Model. The Toolset will build the MainClass based on Race/Gender/Itemtype etc, so this must be correct. (see below)
  • [MODELTYPE] as defined with 2DAs. Typically a short name describing the Model ie. Wolf. See: ItemVariations.xls
  • [MODELSUBTYPE] is optional as defined with 2DAs. Typically a short name describing different Variations of a Model. See: ItemVariations.xls
  • [MODELVARIATION] is optional as defined with 2DAs. Typically one letter a, b, c describing further Variations. See: ItemVariations.xls
  • [LOD] is optional for LOD Versions of Models, where its 0, 2 or 3 from highest to lowest LOD. Options are dependant on resourcetype, however 0 is always required if LOD is applicable.

Creatures

[MainClass]+[ModelName]_[LOD].MMH / PHY

[c]_[deepstkra]_[0].mmh (c_deepstkra_0.mmh)
  • [MainClass] is the general type of the model. When no override is set in APR base.xls, the toolset will generate it based on race and gender. (see below)
  • [ModelName] is the Modelname (including mainclass) described in APR base.xls. When no Modelname is given, and Modeltype is P, the toolset will generate it based on NakedVariations.xls (unsure)
  • [LOD] is optional for LOD Versions of Models, where its 0, 2 or 3 from highest to lowest LOD. Options are dependant on resourcetype, however 0 is always required if LOD is applicable.

This accounts for the game being able to locate a MMH via 2DA definitions. MSH / MAO / DDS Files are referenced by the MMH and each other but follow similar schemes.

Model Main Class Naming Convention

  • base
  • blk - black boxes of various sizes and proportions, used to obscure the portions of models that lie "outside" an interior level where the player shouldn't be able to see.
  • c - creature
  • cai - Cave Int.
  • cav - Caves
  • cdr - Cave Deep Road
  • che - Chantry Exterior
  • chi - Chantry Interior
  • cn - Commmon Body Meshes
  • cs
  • df - dwarf female accessories and components
  • dm - dwarf male accessories and components
  • dne - dwarf noble exterior level pieces
  • dni - dwarf noble interior level pieces
  • dse - Dwarf Slum Exterior
  • dsi - Dwarf Slum Interior
  • dwe - Dwarven Exterior (Orzammar City)
  • dwi - Dwarven Interior
  • ef - elf female accessories and components
  • el
  • em - elf male accessories and components
  • fca - Fereldan Castle
  • fce - Fereldan Castle/City Exterior
  • fci - Fereldan Castle Interior
  • fde
  • fdi - Fereldan Dungeon Interior
  • fhe - Fereldan Human Exterior
  • fhec
  • fhi - Ferelden Human Interior
  • fne - Ferelden noble exterior level pieces
  • frt
  • fti - Fereldan Town Interior
  • ftr
  • fve - Fereldan Village Exterior
  • fx - Effects
  • fxa
  • fxc
  • fxe
  • fxg
  • fxm
  • fxp
  • hf - human female accessories and components
  • hm - human male accessories and components
  • hro - Hero Sets
  • kn
  • lightrig
  • material
  • nm
  • pf - Female specific Gear
  • plc - placeables
  • pm - Male or Genderless specific Gear
  • pn -
  • prp - props
  • prv
  • qm
  • sb - Skybox
  • sca
  • sr
  • tce - Tevinter Castle Exterior
  • tci - Tevinter Castle Interior
  • tfi - Tevinter Fade Interior
  • tools - models used by the toolset
  • trn
  • tti - Tevinter Tower Interior
  • tve - Tevinter Exterior
  • tvi - Tevinter Interior
  • tvm
  • ue
  • uem - Face Bits
  • uh - Face Bits
  • uhm - Face Bits
  • ul
  • ulm - eyelashes
  • v
  • vfx - Visual Effects
  • vis - Vista Objects
  • vst - Vista Objects
  • w - weapon models
  • water - waterfall pieces
  • zz - models used in debugging

Voice Over File Naming Convention

[LineID]_m.WAV
  • with [LineID] replaced by the ID number for the conversation line's string table entry.

This accounts for being able to locate thousands of VO lines, when assigning them to their conversation line.

See voice over for more information on how to manage voice over recording.

Animation File Naming Convention

mh.dg_5p_tn_l_45.ANI

The various parts of the animation name gives you information about the type of animation. This for example means "male human dialogue 5 paces turn left 45 degrees."

All humanoid animations prefix with mh. (male human). There is also a small list of fh (female human), These work across all races pretty much.

After the prefix you have the following:

  • 2p - a 2 person animation... usually lined up (i.e. give and receive, punch and punched, kiss and kissed)
  • am - ambient... full animations that so specific actions (i.e. blacksmith, cheering, clean floor)
  • cb - combat animations
  • cu - custom animation, usually for a specific cutscene or purpose
  • dg - dialog... animation fpr the purpose of use within dialogs (although we use all these animations)
  • po - pose based animations - these are specific poses and gestures for talking dialogs
  • wi - world interaction - similar to ambient but more about interacting with world objects (desks, leaning, sitting)

After the above second prefix the rest is usually descriptive (or some what). Key thing to note:

  • en - enter animation... this is the animation that gets the actor doing the animation... usually from a standing neutral position
  • lp - looping animation - this is the animation that loops to keep the actor in a pose or position
  • ex - exit animation - this is the animation that gets the actor out of the lp animation... usually to a standing neutral position
  • tw - twitch, an animation that plays from the lp animation

So, for example:

  • mh.wi_sit_en - animation goes from standing neutral to sitting
  • mh.wi_sit_lp - animation loops in the sitting pose
  • mh.wi_sit_ex - animation goes from sitting to standing neutral
  • mh.wi_sit_tw1 - an animation that plays from sit_lp, such as someone scratching their head

Vegetation (Speedtree) File Naming Convention

tre c oakfixl.SPT

Vegetation is sorted in main categories via Prefix:

  • bsh - Bushes
  • gra - Grass
  • tre - Trees

The last part is a short description of the vegetation type, ie Oak, which is a Oaktree.

See Also

Retrieved from "http://datoolset.net/mw/index.php?title=Naming_conventions/ru&oldid=17773"