Шаблон:Картка рушія гри/документація

Використання

{{Картка рушія гри}} слід використовувати в статтях про ігрові рушії і їх компонентах: графічних рушіях, фізичних рушіях, звукових рушіях та бібліотеках ігрового штучного інтелекту. Цей шаблон повинен використовуватися в статтях про окремі рушії, але не в оглядових статтях про серії рушіїв.

Цей шаблон служить для уніфікації, систематизації та класифікації ключових відомостей про рушії, а також для категоризації статей про рушії. Він дозволяє компактно, логічно та структуровано зібрати найважливішу інформацію про рушій. Увага!!! Деякі значення є через риску /. Одне із них потрібно стерти тому що шаблон не виведе значення! Наприклад: |розробник/розробники — якщо розробник один, то використовуєте |розробник , якщо їх два чи більше, то |розробники .

Заготовка для копіювання

Шаблон містить україномовні параметри, яким присвоюються значення:

Крім україномовних параметрів, шаблон підтримує й англомовні, які можна використовувати поряд з першими.

{{Картка рушія гри |заголовок = Creation Engine |тип = ігровий |зображення = [[Файл:Creation Engine.gif]] |підпис = Офіційний логотип рушія |розробник/розробники = {{Прапор|США}} [[Bethesda Game Studios]] |програміст/програмісти = |серія = |попередній = |такий = |дата анонса = |дата випуску/дати випуску = |платформа/платформи = [[IBM PC-сумісний комп'ютер]] <br /> [[PlayStation 3]] <br /> [[Xbox 360]] <br /> [[PlayStation 4]] <br /> [[Xbox One]] |операційна система/операційні системи = [[Microsoft Windows]] |мова програмування/мови програмування = [[C++]] |ліцензія = внутрішній |остання версія = |дата останньої версії = |перша гра = [[The Elder Scrolls V: Skyrim]] |дата першої гри = 11.11.2011 |остання гра = |дата останньої гри = |сайт = }}

{{Картка рушія гри |title = |type = |image = |caption = |developer/developers = |programmer/programmers = |series = |preceded by = |followed by = |announced = |released/released plural = |platform/platforms = |operating system/operating systems = |programming language/programming languages = |license = |latest release version = |latest release date = |first released game = |first released game date = |latest released game = |latest released game date = |website = }}

Принцип роботи

З усіх параметрів шаблону {{Картка рушія гри}} тільки один параметр є обов'язковим — тип (type). При використанні шаблону {{Картка рушія гри}} необхідно обов'язково прописати та цей параметр, і його значення. Тим не менш, з технічної точки зору (тобто з точки зору рушія MediaWiki та її системи парсинга шаблонів) шаблон {{Картка рушія гри}} коректно розпізнає відсутність даного параметра та/або його значення та виводить повідомлення про помилку. Всі інші параметри і їх значення необов'язкові.

Зверніть увагу, що для полів шаблона можна вибирати однину або множину. Варіанти однини /множини зазначені через косу риску (/— слеш), з них потрібно вибирати тільки один. Наприклад, якщо в рушія кілька розробників, виберіть параметр множини:

|розробники         = {{Прапор|Німеччина}} Розробник_1<br />{{Прапор|США}} Розробник_2

У таблиці шаблона, вставленій на сторінку зі статтею, це буде виглядати як

Розробники

Розробник_1 Розробник_2

Технічно шаблон {{Картка рушія гри}} представляє собою таблицю, розміщену по правому краю сторінки. Код шаблону розташовується на одній сторінці і не використовує підсторінки. Документація, яку Ви читаєте в цей момент, розташована за адресою {{Картка рушія гри/Документація}}.

Шаблон {{Картка рушія гри}} встановлює на використовувану сторінку категорію, таким чином, він виводить не тільки картку рушія, але й автоматично категоризує сторінку. Причому встановлювана категорія безпосередньо залежить від значення параметра тип (type). Саме тому цей параметр є обов'язковим. Якщо ж цей параметр та/або його значення не вказані, то на цільову сторінку категорія встановлюватися не буде. Механізм шаблону розпізнає простір імен цільової сторінки та проставляє категорії тільки тоді, коли ця сторінка є статтею, тобто перебуває переважно просторі (просторі статей).

Порядок розташування параметрів ролі не грає. Однак якщо у вікі-коді вказані два або більше однакових параметра, то в результаті картці буде виведено лише одне значення того параметра, який був зазначений останнім.

Опис параметрів

заголовок (title)

Повна офіційна назва ігрового рушія, включаючи всі знаки пунктуації та нестандартні символи. Шаблон виводить значення параметра як стандартний вікі-текст. Відповідно, якщо рушій має нестандартне найменування, відобразіть його. наприклад, OGRE (Object-Oriented Graphic Engine) , а неOGRE та не Object-Oriented Graphic Engine.

Якщо у вікікоді значення параметра |заголовок= не заповнено або сам параметр не зазначений, то при інтерпретації шаблону на результуючій сторінці як назву рушія вікірушій автоматично виведе назву сторінки, на якій встановлено шаблон. Іншими словами, вікірушій автоматично прочитає назву сторінки та виведе її в картці як назву рушія.

Увага! Якщо не вказати назву тоді буде не коректно зображатися категорія за типом (хоча назву рушія і виведе). Тип див. нижче.

тип (type)

Найважливіший параметр рушія, єдиний параметр, який разом зі своїм значенням є обов'язковим. Єдиний параметр картки, який приймає тільки заздалегідь фіксовані значення, представлені в таблиці № 1 знизу. Єдиний параметр, від значення якого залежить категоризація цільової сторінки.

Якщо в вікі-коді цільової сторінки параметр |тип= не буде зазначено або буде зазначений, але йому не буде присвоєно значення, то на результуючій сторінці в картці рушія великими червоними літерами буде виведено таке повідомлення про помилку: «Помилка: параметр "тип/type" та/або його значення не вказано», а категорія на цільову сторінку додаватися на буде.

Якщо у вікі-коді цільової сторінки буде присутній параметр |тип= і буде вказано його значення, проте це значення буде некоректним, тобто якщо воно не буде збігатися з одним із заготовлених значень, представлених в таблиці № 1, то на результуючій сторінці в картці рушія великими червоними літерами буде виведено таке повідомлення про помилку: «Помилка: невірне значення параметра "тип/type"», а категорія на цільову сторінку додаватися на буде.

Параметр «тип (type)» призначений для визначення типу рушія. Шаблоном підтримуються такі типи рушіїв:

• Рушій гри
• Графічний рушій
• Фізичний рушій
• Звуковий рушій
• Бібліотека ігрового ШІ

Залежно від значення, наданого користувачем параметру «тип», у результуючій картці буде виведений текст того чи іншого типу рушія з відповідним вікіпосиланням. Також в залежності від значення параметра «тип» на цільову сторінку встановлюється певна категорія.

Табл. № 1: Список заготовлених значень параметра тип (type) , які розпізнаються шаблоном
Скорочене значення українською мовою	Повне значення українською мовою	Скорочене значення англійською мовою	Повне значення англійською мовою	Виведений у картці текст	Встановлювана категорія
ігровий	ігровий рушій	game	game engine	Рушій гри  (Список)	Категорія:Ігрові рушії за алфавітом
графічний	графічний рушій	graphics	graphics engine	Графічний рушій	Категорія:Графічні рушії
фізичний	фізичний рушій	physics	physics engine	Фізичний рушій	Категорія:Фізичні рушії
звуковий	звуковий рушій	sound	sound engine	Звуковий рушій	Категорія:Звукові рушії
ІІ	бібліотека ІІ	AI	AI library	Бібліотека ігрового ІІ	Категорія:Ігровий штучний інтелект
будь-який набір символів будь-якою мовою будь-якої довжини, що не збігається ні з одним з вище представлених значень				Помилка: невірне значення параметра «тип/type».	Категорія встановлюватися не буде

зображення (image)

У значенні параметра |зображення= слід прописати файл зображення, який буде містити логотип рушія. Не вставляйте скріншоти або будь-які інші ілюстрації до картки рушія, окрім як зображень офіційного логотипу рушія. Для коректної вставки зображення необхідно прописати [[Файл:Example.png|256px]]. Параметр |thumb ставити не потрібно. 256 пікселів — рекомендоване значення ширини, не обов'язкове. Однак намагайтеся не перевищувати його, оскільки чим більше значення ширини, тим ширше буде розтягнута картка, і, відповідно, тим більше площі сторінки статті вона займе. Зауважте, що якщо ви не встановите ширину зображення шляхом указання пікселів, то зображення виведеться у своєму «рідному» дозволі.

підпис (caption)

Короткий опис зображення, зазначеного вище. Виводиться дрібним курсивом. У більшості випадків опис має бути Офіційний логотип рушія або подібно до цього, оскільки у зображенні повинен знаходиться тільки логотип. Також можна взагалі не використовувати підпис до зображення. Однак врахуйте, що якщо зображення не зазначено, тобто параметр |зображення= не заповнений, то параметр |підпис= теж не повинен бути заповнений. Іншими словами, якщо немає зображення, то не повинно бути і підпису.

розробник/розробники (developer/developers)

Розробник або розробники рушія. Розробник — це компанія, команда або студія, а не окремі працівники. У разі більшості вільних рушіїв, які не мають чітко вираженої команди та розроблені декількома самостійними людьми, не використовуйте параметр |розробник=. Впишіть програмістів рушія в параметр програмісти=.

програміст/програмісти (programmer/programmers)

Програміст або програмісти, які є ключовими розробниками рушія, тобто взяли в його розробці основну та домінуючу участь. Якщо дані люди мають не україномовні імена та прізвища, то потрібно вказувати оригінальне написання їхніх даних, але використання шаблонів типу {{lang-xx}} може занадто «розтягнути» поля картки і тим самим зіпсувати її дизайн, тому бажано користуватися шаблоном {{comment}}.

серія (series)

Часто окремі ігрові рушії є складовими серії ігрових рушіїв, яка може розвиватися протягом десятиліть. Загальну назву серії ігрових рушіїв якраз і слід вказувати в цьому параметрі, навіть якщо ця назва майже повністю (за винятком номера версії) збігається з назвою конкретного рушія. Якщо цей рушій не є частиною серії, не заповнюйте цей параметр.

попередній (preceded by)

Попередній рушій у серії відносно даного, його попередник. Якщо цей рушій не є частиною серії, не заповнюйте цей параметр.

такий (followed by)

Наступний рушій у серії відносно даного, його наступник. Якщо цей рушій не є частиною серії, не заповнюйте цей параметр.

дата анонса (announced)

Дата, коли цей рушій уперше був офіційно анонсований. Чутки та неофіційні відомості не є офіційним анонсом. Небагато рішіїв мають офіційний анонс.

дата випуску/дати випуску (released/released plural)

Одна або кілька дат, коли відбувся офіційний реліз рушія. Врахуйте, що лише комерційно розповсюджувані та вільні рушії мають дату виходу, внутрішні рушії її не мають. Ця дата вказує на те, що сторонні компанії з цього моменту можуть почати ліцензувати рушій. Також врахуйте, що дата виходу першої гри на рушії не є датою релізу. Разом з тим деякі вільні рушій теж мають дати виходу за версіями. Ще одним моментом є те, що тут повинна бути вказана офіційна дата виходу першої версії рушія, а не останньої. Номер останньої версії і дата її виходу повинні зазначатися в параметрах, розглянутих нижче.

платформа/платформи (platform/platforms)

Одна або кілька апаратних платформ комп'ютера, роботу (виконання) на яких підтримує рушій. Апаратні платформи — це в загальному випадку типи персональних комп'ютерів (найпоширеніші — IBM PC-сумісний комп'ютер та Macintosh) і всі ігрові консолі (приставки). Операційні системи в цьому параметрі вказувати не треба. Будь ласка, не вказуйте Багатоплатформність, бо це ні про що конкретно не говорить. Вказуйте конкретні платформи.

операційна система/операційні системи (operating system/operating systems)

Одна або кілька операційних систем, роботу (виконання) на яких підтримує рушій. Вказуйте лише серію операційних систем (наприклад, Microsoft Windows, Linux, Mac OS X), а не кожну версію ОС окремо. Операційні системи ігрових консолей (наприклад, Xbox OS) вказувати не треба, вказуйте лише операційні системи для персональних комп'ютерів.

мову програмування/мови програмування (programming language/programming languages)

Одна або кілька мов програмування, на якій/яких написаний рушій.

ліцензія (license)

Ліцензія на програмне забезпечення, згідно з якою поширюється рушій. Якщо ліцензій кілька, вказуйте їх усіх. У загальному випадку можливі три основні ситуації з ліцензіями:

# Якщо рушій є вільним, тобто використовує вільну ліцензію типу GNU Free Documentation License, Ліцензія MIT або Ліцензія BSD, то вкажіть це і конкретно його ліцензію або ліцензії. Наприклад, «вільна, Ліцензія BSD».

# Якщо рушій є пропрієтарним, тобто закритим, і одночасно внутрішнім, тобто використовується тільки всередині якої-небудь компанії для внутрішніх проєктів і не поширюється, у тому числі не ліцензується, то напишіть «пропріетарна, не ліцензується — тільки внутрішнє використання».

# Якщо рушій є комерційним, тобто ведеться продаж ліцензій на його використання, то напишіть «комерційна — доступний для ліцензування».

Параметр «ліцензія/license», як і параметр «тип/type», має кілька заготовлених значень. При установці у вікі-коді цих заготовлених значень в результуючій картці буде підставлений певний специфічний для даного значення текст. У таблиці № 2 наведено список заготовлених значень для параметра «ліцензія/license». Якщо введене в вікі-коді значення не відповідає жодному із заготовлених значень, то дане значення буде виведено без всяких змін і підстановок.

Зауважте, що, незважаючи на те, що механізм параметра «ліцензія/license» схожий з таким для параметра «тип/type», є дві відмінності. По-перше, параметр «ліцензія/license» необов'язковий: якщо він пропущений або йому не присвоєно значення, то це не буде вважатися помилкою — у картці рушія просто не буде виводитися рядок «Ліцензія». По-друге, параметр «ліцензія /license» дозволяє вказувати «своє, власне» значення, а не тільки заздалегідь заготовлені.

Табл. № 2: Список заготовлених значень параметра ліцензія (license) , Які розпізнаються шаблоном
Значення українською мовою в жіночому роді	Значення українською мовою в чоловічому роді	Значення англійською мовою	Цифрове значення	Виведений у картці текст
внутрішня	внутрішній	internal	1	пропріетарна, не ліцензується — тільки внутрішнє використання
комерційна	комерційний	commercial	2	комерційна — доступний для ліцензування
Будь-який набір символів будь-якою мовою будь-якої довжини, що не збігається ні з одним з вище представлених значень				Цей набір символів без всяких змін і викривлень

остання версія (latest release version)

Номер останньої випущеної (опублікованій) версії рушія. Цей параметр у першу чергу застосуємо для вільних рушіїв, які орієнтовані на реліз самі по собі, а не на використання в конкретній грі і серії ігор. Також, хоч і в дещо меншому ступені, остання версія актуальна для комерційних ігрових рушіїв — розробники випускають нові версії з новими можливостями та інструментарієм. Для внутрішніх рушіїв цей параметр не застосуємо. Не вказуйте в цьому параметрі дату виходу — її треба вказувати в параметрі |дата останньої версії =, описаному нижче.

дата останньої версії (latest release date)

Дата виходу (випуску, релізу) останньої версії рушія. Значення цього параметра буде стояти у картці рушія одразу після номера останньої версії. Вказуйте максимально точну дату виходу аж до дня.

перша гра (first released game)

Перша відеогра, яка використовувала цей рушій. Вказуйте в цьому параметрі тільки гру, дату випуску гри вказуйте в параметрі |дата першої гри =, описаному нижче.

дата першої гри (first released game date)

Дата випуску першої комп'ютерної гри, яка використовувала цей рушій. Вказуйте в цьому параметрі тільки дату, саму гру вказуйте в параметрі |перша гра =, описаному вище. вказуйте дату максимально точно, аж до дня. Якщо гра вийшла в різних регіонах і/або на різних платформах в різний час, то вказуйте найпершу дату виходу гри з усіх існуючих.

остання гра (latest released game)

Остання комп'ютерна гра, яка використовувала або буде використовувати цей рушій. Вказуйте в цьому параметрі тільки гру, дату випуску гри вказуйте в параметрі |дата останньої гри =, описаному нижче. Постарайтеся уникнути невизначеностей, припущень та здогадок: якщо для розроблюваної гри точно не відомо, який рушій вона буде використовувати, то краще цю гру не вказувати.

дата останньої гри (latest released game date)

Дата випуску останньої випущеної комп'ютерної гри, що використовувала цей рушій. Вказуйте в цьому параметрі тільки дату, саму гру вказуйте в параметрі |остання гра =, описаному вище. Вказуйте дату максимально точно, аж до дня. Якщо гра вийшла в різних регіонах і/або на різних платформах в різний час, то вказуйте найпершу дату виходу гри з усіх існуючих.

сайт (website)

Офіційний сайт даного рушія. Якщо офіційний сайт відсутній, то вкажіть посилання на вебсторінку на сайті розробника рушія, на якій описується сам рушій. Якщо в рушія відсутній офіційний сайт і йому не присвячені вебсторінки на сайті розробника, то пропустіть цей параметр. На відміну від карток ігри та серії ігор, цей шаблон просто виводить значення параметра |сайт = без будь-яких модифікацій та обмежень. Тому ви самі повинні вказати Уніфікований локатор ресурсів та опис, наприклад, [http://www.megaengine.com Офіційний сайт рушія].

Службові параметри

Крім описаних вище основних параметрів, шаблон {{Картка рушія гри}} має і «службові» параметри, які впливають на особливості рендеринга картки вікірушієм. «Службовий» статус таких параметрів абсолютно умовний, для шаблона немає «основних» та «службових» параметрів, всі однакові та рівнозначні. «Службовий» статус даними параметрами присвоєно тому, що їх встановлення та зміна не рекомендується в більшості випадків. Параметри за замовчуванням налаштовані максимально ефективно, і їх зміна через службові рекомендується лише в особливих випадках.

стиль заголовка (titlestyle)

Код мови розмітки CSS, який буде застосований до значення параметра |заголовок=, тобто до назви рушія в самому верху картки. Коли параметр |стиль заголовка= не встановлений або встановлений, проте його значення не вказано, використовується форматування заголовка за замовчуванням, відповідно до якого розмір шрифту заголовка складає 150% від розміру шрифту сторінки, і сам заголовок виводиться в центрі. Код, який застосовується за замовчуванням: style="font-size:150%; text-align:center;. Останнім часом зміна стилю заголовка картки не прийнята і не бажана.

width

Ширина картки рушія, що виводиться на вікісторінці. Значення може бути зазначено в пікселах, відсотках або друкарських одиницях em. При присвоєнні значення потрібно вказати тип даних — одиницю виміру, — причому одразу після числа без пропусків. Наприклад, 200px, 15%, 25em. За умовчанням значення параметра width одне 22em.

nocat

Шаблон {{Картка рушія гри}} встановлює на цільову сторінку категорію в залежності від значення параметра "тип". Однак іноді бажано заборонити картці самостійно встановлювати які б то не було категорії. Саме для відключення установки категорій існує параметр "nocat". Якщо у вікі-коді цільової сторінки в шаблоні параметр "nocat" встановлено і йому присвоєно абсолютно будь-яке значення, то автоматична категоризація буде відключена. Під абсолютно будь-яким значенням розуміється набір будь-яких символів будь-якої довжини, який не є порожнім і не складається з одних лише пробілів. Якщо ж цей параметр не встановлений або встановлений, але йому присвоєно пусте значення (порожній рядок, набір прогалин), то автоматична категоризація буде працювати.

Приклад

На цьому прикладі вікікод зліва буде інтерпретуватися рушієм MediaWiki так, як показано в правій частині сторінки.

CryEngine 2
Рушій гри (Список)
Офіційний логотип рушія
Розробник	Crytek
Ключові програмісти	Мартін Міттрінг Карстен Вензель
Частина серії рушіїв	CryEngine (серія рушіїв)
Попередній рушій серії	CryEngine
Наступний рушій серії	CryEngine 3
Дата анонсу	23 січня 2006 року
Дата випуску	23 січня 2007 року
Апаратна платформа	IBM PC-сумісний комп'ютер
Підтримувана ОС	Microsoft Windows
Написаний мовою	C++, Lua
Ліцензія	комерційна — доступний для ліцензування
Остання версія	1.2 / 6 березня 2008 року
Перша гра на рушію	Crysis / 16 жовтня 2007 року
Остання гра на рушію	Entropia Universe / 17 серпня 2009 року
CryEngine2.com

{{Картка рушія гри
|заголовок               = CryEngine 2
|стиль заголовка         = 
|тип                     = ігровий 
|зображення             = [[Файл:Cryengine2.png|256px]]
|підпис                 = Офіційний логотип рушія 
|розробник             = {{Прапор|Німеччина}} [[Crytek]]
|програмісти            = {{comment|Мартін Міттрінг|Martin Mittring}}<br />{{comment|Карстен Вензель|Carsten Wenzel}} 
|серія                   = [[CryEngine (серія рушіїв)]]
|попередній              = [[CryEngine]]
|такий               = [[CryEngine 3]]
|дата анонса             = [[23 січня]] 2006 року 
|дата випуску            = [[23 січня]] 2007 року 
|платформа               = [[IBM PC-сумісний комп'ютер]]
|операційна система    = [[Microsoft Windows]]
|мова програмування   = [[C++]], [[Lua]]
|ліцензія                = commercial
|остання версія        = 1.2 
|дата останньої версії   = 6 березня 2008 року 
|перша гра             = [[Crysis]]
|дата першої гри        = 16 жовтня 2007 року 
|остання гра          = [[Entropia Universe]]
|дата останньої гри     = 17 серпня 2009 року 
|сайт                    = [http://www.cryengine2.com/ CryEngine2.com]
}}

Якщо щось не працює можна копнути Pig1995z.