Difference between revisions of "Naming conventions/ru"

Revision as of 02:40, 2 December 2011

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

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

Используйте уникальные имёна. Если имеется два ресурса с одинаковым именем, то загружаться будет только один, причём выбор будет сделан согласно приоритету папок (en).

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

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

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

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

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

• Использовать в именах ресурсов только латиницу, да тулсет вам и не даст назвать ресурс кириллическими символами.
• Не применять префиксы, используемые Bioware'цами, например "gen".

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

cir200cr_bloodmage

• Три буквы префикса указывают на игровую область, в которой используется ресурс, (предыстория, башня Круга, Лотеринг и т.д.) или "gen" для общих (глобальных) ресурсов.
• Трёхзначный номер, присваиваемый конкретной локации игровой области, начиная со 100 и увеличивая на 100 для крупных локаций. Для мелких локаций, например домов, нумерация идёт в пределах номера родительской локации. Общие (глобальные) ресурсы часто получают номер 000.
• Двухбуквенный код, указывающий на тип, к которому принадлежит данный ресурс ("ar" - локация, "al" - список локаций, "ip" - размещаемый объект (placeable), "cr" - существа, "im" - предметы, "tr" - триггеры, "pt" - plot-файлы, "st" - сцены, "cs" - ролики, "wp" - точки на карте). Основным исключением являются скрипт ресурсов, которые имеют точно такое же имя, как и сам ресурс. Ресурсы диалогов практически всегда также имеют название, повторяющее название ресурса, к которому они привязаны. Названия ресурсов торговцев, как правило, также повторяют название имя владельца, но с приставкой "store_".
• Подчеркивание.
• Оставшаяся часть названия в принципе и есть само имя ресурса, присваивается в свободной форме с тем, чтобы напомнить вам с первого взгляда, что это за ресурс.

Соглашение об именах файлов моделей

Предметы

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

Пример: [ef]_[rob]_[enc][a]_[0].mmh - ef_rob_enca_0.mmh

• [MAINCLASS] - Класс модели. Тулсет использует его для сортировки по признаку расы/пола/типа и т.д., так что эта часть названия должна соответствовать представленному ниже списку.
• [MODELTYPE] - Тип модели. Определяется в 2DA-таблицах. Обычно это короткое имя, описывающее модель. Смотрите ItemVariations.xls (en).
• [MODELSUBTYPE] - Подтип модели. Не является обязательной частью названия. Определяется также в 2DA-таблицах. Обычно это короткое имя, описывающее различные вариации модели. Смотрите ItemVariations.xls (en).
• [MODELVARIATION] - Вариация модели. Не является обязательной частью названия. Определяется также в 2DA-таблицах. Обычно это одна буква, описывающая дальнейшие вариации. Смотрите ItemVariations.xls (en).
• [LOD] - Уровень детализации. Опционально для моделей, к которым применим разный уровень детализации, где 0, 2 или 3 от большего к меньшему уровню детализации. Варианты зависят от ResourceType, тем не менее 0 всегда требуется, если LOD применимо.

Существа

[MAINCLASS]+[MODELNAME]_[LOD].MMH / PHY

Пример: [c]_[deepstkra]_[0].mmh - c_deepstkra_0.mmh

• [MAINCLASS] Класс модели. Если не переопределён, то классы модели определяются ​​в APR base.xls (en) и тулсет будет генерировать его согласно представленному ниже списку.
• [MODELNAME] Название модели (включая класс модели). Названия модели также определяются ​в APR base.xls (en). При отсутствии названия модели либо если название модели - "P" тулсет будет генерировать его на основе NakedVariations.xls (en)(не уверен).
• [LOD] Уровень детализации. Опционально для моделей, к которым применим разный уровень детализации, где 0, 2 или 3 от большего к меньшему уровню детализации. Варианты зависят от ResourceType, тем не менее 0 всегда требуется, если LOD применимо.

Данный порядок объясняет игре, где она может, используя 2DA-файлы, найти MMH (en).

MAO (en) и DDS (en) - файлы, связанные через MMH (en) и придерживающиеся аналогичных схем в формировании названии файла.

Классы модели

• 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

• Art Resources
• Designer Resources
• Compatibility