Рекомендации авторам / Recommendations for authors

[Mr A]

Приветствую, новоиспеченный автор конфига(если это не вы - здесь делать нечего)!

 

Ты создал что-то новое и полезное, и решил поделиться с другими? Готов отвечать на вопросы пользователей? Поддерживать конфиг в актуальном состоянии каждый релиз? Тогда смело можно создавать тему, но, перед этим, прочти правила, как ее оформить.

 

Оформление заголовков

 

В квадратных скобках указывается поддерживаемая конфигом в данный момент версия мода (стабильная версия, или тестовая версия, а не номер ночного билда), через запятую - дата обновления темы (как конфига, так и других файлов) в формате ДД.ММ.ГГ. Затем ник автора, отделяемый пробелами с обеих сторон. Продолжение - свободно.

Пример: "[3.5.0-test6, 05.04.13] Super_Author конфиг с иконками! Всем нежных боеукладок у врагов:3"

 

Совет: не перегружайте заголовок лишней информацией, делайте его настолько кратким, насколько это возможно.

Перегруженное название усложняет восприятие. Примеры:

 

Плохое название:

[5.1.0-test3, 15.08.14] MEGANOGIBATOR10000's XVM Config v. 0.8.11.198 (Multilingual) + Модпак № 123,456,789(для тестового) + Другие Модпаки № 12,34,56,78,90

 

Хорошее название:

[5.1.0-test3, 15.08.14] MEGANOGIBATOR10000's XVM Config v.1.5 + мой модпак на основе XVM

 

'Что это даёт?'

Станет возможна сортировка по названию тем; пользователь сможет легко определить, стоит ли заходить в тему за новым конфигом для его версии мода, и не забросил ли ее автор.

 

Оформление первого сообщения

Сообщение должно содержать внутриигровые скриншоты визуальных изменений, вносимых конфигом. На них должны быть представлены:

• загрузка боя,
• обе панели всех типов ушей (итого 4),
• окно по нажатию Tab,
• маркеры и отлетающий урон (а также попадание в боеукладку) на них (мертвый и живой союзник, противник, обычный и расширенный режим, итого 8),
• хитлог (после повреждения нескольких танков),
• полоса захвата (своя и чужая),
• миникарта (с отметками всех типов, поддерживаемых ей).

'Что это даёт?'

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

 

Оформление XVM.xc

Рекомендуется в самом конфиге заполнять раздел "definition":

"definition": {
"author": "Super_Author", // автор конфига
"description": "С иконками", // описание конфига
"url": "http://www.koreanrandom.com/forum/forum/50-/", // адрес, где выкладываются обновления конфига, обратите внимание на формат обрезки до цифры с тире
"date": "05.04.2013", // дата последней модификации конфига
"gameVersion": "0.8.4", // поддерживаемая версия игры
"modMinVersion": "3.5.0-test6" // минимально необходимая версия мода XVM
},

'Что это даёт?'

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

 

Вопросы по данной теме - в ЛС.

Edited March 24, 2014 by Mr 13
дополнения

[Mr A]

Архив с конфигом

Конфиг запаковывается в zip архив, который пользователь распакует в папку с игрой. Имя архива должно быть информативным, например, AuthorName_29.08.13.zip - виден автор конфига и дата релиза.

'Структура папок'

AuthorName_29.08.13.zip
└───res_mods
    └───xvm
        │   xvm.xc
        │
        ├───configs
        │   └───AuthorName
        │           @xvm.xc
        │           alpha.xc
        │           battle.xc
        │           battleLoading.xc
        │           captureBar.xc
        │           colors.xc
        │           elements.xc
        │           finalStatistic.xc
        │           hangar.xc
        │           hitLog.xc
        │           hotkeys.xc
        │           iconset.xc
        │           login.xc
        │           markers.xc
        │           markersAliveExtended.xc
        │           markersAliveNormal.xc
        │           markersDeadExtended.xc
        │           markersDeadNormal.xc
        │           minimap.xc
        │           minimapCircles.xc
        │           minimapLabels.xc
        │           minimapLines.xc
        │           playersPanel.xc
        │           rating.xc
        │           squad.xc
        │           statisticForm.xc
        │           texts.xc
        │           turretMarkers.xc
        │           vehicleNames.xc
        │
        └───res
            │   SixthSense.png
            │
            └───AuthorName
                ├───fonts
                │       Font1.ttf
                │       Font2.ttf
                │
                └───img
                        Image1.png
                        Image2.png

Дополнительные файлы (картинки, шрифты) помещаются помещаются в xvm/res/AuthorName, а не в папку с конфигом - это отделит мух от котлет при редактировании пользователем конфига.

'Содержимое xvm.xc'

/**
 * The boot configs file.
 *
 * Reference format: ${"path to config file":"."}
 * // - comment out the line (will not be used)
 *
 * ---------------------------------------------------------------
 * Загрузочный файл конфигов.
 *
 * Формат ссылки: ${"путь к файлу конфига":"."}
 * // - закомментировать строку (использоваться не будет)
 */
//${"configs/@Default/@xvm.xc":"."}
${"configs/AuthorName/@xvm.xc":"."}

В файл может быть добавлена еще одна строчка (при распространении архива с двумя конфигами) с другим путем для загрузки, тогда простое комментирование (//) позволит мгновенно сменить используемый конфиг.

'Что это дает?'

Не будут затерты файлы других авторов (исключение - иконка шестого чувства), облегчается задача редактирования пользователем конфига, его загрузка в редактор.

При использовании xvm.xc возможно распространять все конфиги в одном архиве, дав пользователю возможность переключаться между ними в любой момент.

Edited August 28, 2013 by Mr A

[13]

Обратите внимание: 

Если Вы публикуете в этом разделе сборку модов (т.н. "модпак") на основе XVM, так же вы обязательно должны отдельно прикрепить и описать вашу конфигурацию без посторонних файлов.
Если тема содержит только модпак (без возможности отдельной загрузки и ознакомления с конфигурацией XVM), то она может быть перенесена в раздел "Модпаки", поскольку не соответствует тематике раздела "Конфигурации XVM".