This is a documentation for Board Game Arena: play board games online !
БГА Студио Гуиделинес
БГА Студио Гуиделинес
Оригиналлy Фром: https://www.slideshare.net/boardgamearena/bga-studio-guidelines
Wхy гуиделинес?
Море анд моде гаме публисхерс аре цхоосинг Боард Гаме Арена фор тхеир гаме адаптатионс бецаусе тхе qуалитy оф тхесе адаптатионс ис хигх. Иф wе wант то цонтинуе то хаве нице гамес ин тхе футуре, wе хаве то маке суре тхат еверy гаме публисхед ин тхе БГА платформ ис матцхинг тхе qуалитy стандардс оф БГА. Тхесе гуиделинес аре хере то хелп yоу то маке yоур гаме еасy то усе бy БГА плаyерс, анд то маке суре итс гоинг то бе валидатед бy тхе гаме публисхер.
Генерал гуиделинес
Тхе 3 маин импортант гуиделинес
- Иф а плаyер кноwс тхе реал боард гаме, хе схоулд бе абле то плаy yоур адаптатион wитх но леарнинг.
- Фиделитy то тхе оригинал гаме ис ан абсолуте реqуиремент.
- Дон'т трy то цреате а видео гаме: маке yоур гаме интерфаце ас цлосе ас поссибле то хоw тхе оригинал боард гаме лоокс лике.
Гаме лаyоут
I-1 Дон'т хиде гаме елементс
Манy боард гамес хаве а лот оф материал то дисплаy, анд цомпутер сцреенс аре сометимес тоо смалл. Бут yоу аре луцкy: yоур гаме wилл бе он а wебпаге wитх а сцроллинг фунцтионалитy. Басицаллy, yоу алwаyс хаве соме море спаце аваилабле . Дон'т хиде гаме елементс бехинд менус, субменус, диалогс, … бут дисплаy тхем дирецтлy он тхе маин паге. Типс: евентуаллy, yоу цан усе ХТМЛ анцхор линк то јумп бетwеен тхе дифферент елементс оф тхе паге иф тхе паге хеигхт ис верy биг.
Еxамплес:
Ин Амyитис, цхарацтерс цардс аре елементс yоу дон'т хаве то цхецк алл тхе тиме. Тхус, wе плацед тхем ат тхе боттом оф тхе паге анд yоу хаве то сцролл то сее тхем.
I-2 Маке ит флуид
БГА гаме интерфаце ис «флуид». Ит меанс тхе интерфаце wидтх цан варy ин ордер то усе еxтра спаце он тхе сцреен wхен аваилабле. ХТМЛ анд ЦСС гиве ус а лот оф поссибилитиес то адапт а wеб цонтент то а гивен броwсер wидтх. Yоу хаве то усе ХТМЛ анд ЦСС:
- То аллоw плаyерс оwнинг а биг сцреен то ењоy тхе гаме цомфортаблy wитхоут сцроллинг тхе паге.
- То аллоw плаyерс wитх а сцреен оф јуст 1024пx
Типс: фор еацх елемент оф тхе гаме, ансwер тхис qуестион « хоw манy тимес дуринг а гаме до I неед то цхецк/усе тхис елемент? ».Лесс фреqуентлy усед елементс цан бе плацед белоw
Еxамплес:
Цаyлус: wхен wе хаве а 1024пx смалл wидтх то плаy тхе гаме – евен иф тхеy хаве то сцреен, аваилабле буилдингс аре плацед сцролл он тхе тхе ригхт анд белоw тхе боард. Он ларгер сцреен, тхесе тилес аре плацед он тхе ригхт оф тхе боард. Тхис ис а верy басиц усаге оф тхе отхерс. « флоат:лефт » ЦСС пропертy.
I-3 Усе wхитеблоцкс
Wхите блоцкс аре « див » ХТМЛ елемент wитх тхе « wхитеблоцк » цласс (wхите анд транспарент бацкгроунд). Тхис ис тхе рецоммендед wаy то гатхер гаме елементс тогетхер ин yоур гаме интерфаце wхен тхеy аре нот дирецтлy он а боард. Wхитеблоцкс хелпс yоу то организе тхе спаце ин ордер ит цан бе еасилy ундерстоод бy плаyерс.
Типс: yоу цан усе а
титле инсиде тхе wхитеблоцк то хелп плаyерс то ундерстанд wхат ис инсиде ор то wхо ит белонгс.
Ин Тхе Yеар оф тхе Драгон гаме интерфаце, wитх wхитеблоцкс анд х3 титлес /пицтуре хере/
I-4 Усе плаyер панелс
БГА плаyерс аре усед то лоок ат плаyер панелс wхен тхеy неед ан информатион абоут а плаyер.
Усинг плаyер панелс цан аллоw yоу то саве а лот оф спаце он тхе маин гаме спаце. Ин генерал, тхе фоллоwинг информатион ис плацед ин тхе плаyер панел:
- Плаyерс ресоурцес (и.е. смалл гаме елементс тхе плаyер ис кеепинг ин фронт оф хим ин тхе реал гаме).
- Суммарy информатион абоут плаyер (и.е. нумбер оф цардс ин ханд, нумбер оф цардс плаyед...).
- « Фирст плаyер » токен.
- Сцоре.
Плаyер панелс ин Сеасонс. /пицтуре/ А лот оф усефул информатион цан фит инто тхесе смалл спацес :)
Ноте: фор алл гамес, yоу муст алwаyс усе тхе стандард БГА сцоре цоунтер (wитх тхе стар). Плаyерс аре усед то цхецк тхис цоунтер то сее wхо ис wиннинг тхе гаме.
I-5 Усе статус бар ацтионс
Wхен соме гаме ацтион ис партицулар то а специфиц гаме стате, тхе гоод працтице ис то усе а статус бар ацтион (ХТМЛ линк).
Дон'т трy то плаце соме ицон ин yоур маин гамеинтерфаце тхат wилл бе уселесс 95% оф тхе тиме: ит такес спаце анд макес тхе интерфаце море цомплеx то ундерстанд.
Статус бар ацтионс ин Тобаго /пицтуре/
Гаме усабилитy
II-1 Усе тоолтипс
Wитх БГА Студио итс верy еасy то ассоциате а тоолтип он анy елемент оф тхе гаме. Еацх тиме тхис ис поссибле: адд а тоолтип то еxплаин то тхе плаyерс:
- Wхат ис тхис гаме елемент?
- Wхат хаппенс иф I цлицк он ит?
Хоwевер, тоолтипс схоулд НОТ бе усед то дисплаy дyнамиц информатион абоут тхе цуррент гаме то саве спаце он тхе гаме интерфаце.
Тyпицаллy, регулар плаyерс схоулд бе абле то цард тоолтип плаy wитх но тоолтипс.
Типс : yоу цан плаце анy ХТМЛ елемент ин тоолтипс. Со yоу цан маке тхем ас рицх анд беаутифул ас yоу неед :)
II-2 Усе лефт цлицк онлy
- Тхе wхоле гаме схоулд бе плаyабле wитх онлy симпле лефт буттон моусе цлицк.
- Цонтеxт менус схоулд нот бе усед.
- Драг-н-дроп схоулд бе авоидед (иф yоу wант то усе ит анywаy, yоу схоулд маке а цлицк басед алтернативе аваилабле).
- Моусе ицон муст цханге он цлицкабле елементс (« цурсор:поинтер » ЦСС пропертy).
II-3 Маке yоур интерфаце интуитиве
Иф yоур тестерс хаве дифферент опинионс абоут « хоw то триггер соме гаме ацтион », маyбе
тхе бест ис то маке северал оптионс поссибле фор тхис гаме ацтион. Ин тхе цасе тхере ис а цомплеx ацтион то до бy тхе плаyер (еx: селецт соме цардс, тхен цлицк он ан ацтион буттон), десигн yоур еррор мессагес ин ордер тхеy цан гуиде тхе плаyер(еx : « плеасе селецт соме цардс фирст »).
Типс: Фор цомплеx гамес, ит ис симпле анд усефул то хигхлигхт тхе ареа оф тхе интерфаце wхере плаyер схоулд фоцус хис аттентион (усинг онЕнтерингСтате/онЛеавингСтате анд ЦСС).
Тхе Босс: wхен а плаyер цлицкс он а цард wитх но селецтед цубес, тхе интерфаце теллс ус то селецт соме цубе фирст.
II-4 Усе тхе гамелог
Wитх БГА Студио ит ис верy еасy то плаце сометеxт (ор ХТМЛ цоде) ин тхе гамелог.
Дон'т хеситате то усе тхе гаме лог.
Плаyерс аре нот алwаyс ин фронт оф тхе гаме паге wхен тхеир оппонентс аре макинг тхеир мовес.
Ин аддитион, тхе цомпутер манипулатес гаме елементс фастер тхан yоу усуаллy до wитх тхе реал боард гаме анд евен регулар плаyерс цан гет бехинд оф wхат хаппенед сометимес.
Yоу схоулд бе абле то ундерстанд тхе « гаме сторy » бy реадинг тхе гаме лог.
II-5 Телл плаyерс абоут аутоматиц ацтионс
Верy офтен, дуринг а гаме yоу аре ин а ситуатион wхере:
- Онлy оне ацтион ис поссибле фор тхе ацтивеплаyер, ор
- А сериес оф ацтион хас то бе доне (аццординг то тхе рулес) wитхоут анy плаyерс ацтионс.
Ин тхесе ситуатион, yоу муст ор yоу маy триггер тхесе ацтионс аутоматицаллy.
Ин анy цасе, yоу муст маке суре тхат плаyерс ундерстанд wхат ис хаппенинг, отхерwисе тхеy wилл пробаблy репорт а буг.
Стоне Аге: пеопле аре фед аутоматицаллy ат тхе енд оф тхе турн, бут плаyерс цан алwаyс сее wхат хаппенед еxацтлy ин тхе гамелог.
- Усе тхе гаме лог то траце алл ацтионс перформед аутоматицаллy.
- Усе сyнцхроноус нотифицатионс хандлерс то слоw доwн тхе еxецутион оф аутоматиц ацтионс,со тхат плаyерс цан ундерстанд wхат ис хаппенинг.
II-6 Цонфирм а мове
Ас а руле оф тхумб, дон'т провиде а wаy то цонфирм а мове. Цонфирминг а мове слоwс доwн тхе усер интерфаце анд тхус, тхе гаме флоw. Yоу цан евентуаллy аллоw а плаyер то цонфирм а мове иф тхис ис а верy цритицал степ ин а гаме, анд иф ит ис поссибле тхат а плаyер триггерс тхе ацтион бy аццидент.
Хаwаии : ендинг а турн ис а цритицал ацтион тхат хаппенс онлy 5 тимес пер плаyер ин а гаме. Ин тхис цасе, ит ис аццептабле (анд а гоод идеа) то хаве а цонфирматион диалог.
II-7 Транслатабле интерфаце
Wитх БГА Студио итс верy еасy то транслате yоур гаме ин анy лангуаге, усинг БГА цоллаборативе транслатион сyстем. Цхецк тхе ФАQ анд тхе еxампле гамес то леарн хоw то децларе yоур стрингс со тхат еверy мессаге ин yоур цоде цан бе манагед бy тхе интернатионализатион сyстем.
Диамс 100 % транслатед ин Полисх
Оригинал гаме репресентатион
III-1 Усе тхе оригинал арт
Тхе лесс yоу аре модифyинг тхе оригинал арт оф тхе гаме, тхе беттер.
Итс импортант фор публисхерс тхат а боард гаме адаптатион лоокс лике тхе реал боард гаме. Сометимес ит цан бе усефул то модифy соме елементс оф тхе гаме то саве соме спаце он тхе сцреен – бут трy то авоид ит.
Типс: иф yоу хаве нот еноугх спаце он тхе сцреен, редуце тхе сизе оф тхе гаме елементс.
Трy то маке суре тхеy аре рецогнизабле фор плаyерс wхо плаyед регуларлy, анд адд а тоолтип то хелп бегиннерс то фигуре оут wхат тхеy аре.
Госу : тхе оригинал цардс аре усед, wитх тоолтипс.
III-2 Бе царефул абоут плаyер ассистанце
Ас а руле оф тхумб, ин ордер то респецт тхе оригинал боард гамес, yоу схоулд нот интродуце анy плаyер ассистанце феатуре.
Ан ассистанце муст нот бе интродуцед иф ит дирецтлy хелпс тхе плаyер то фигуре оут иф хис мове ис гоод ор бад.
Ан ассистанце маy бе интродуцед иф ит цан хелпс тхе паyер то фигуре оут wхат мовес аре аваилабле.
Гyгèс : тхе ассистанце схоwс yоу аваилабле мовес, бут ис нот алертинг yоу абоут ступид мовес (лике тхе уппер лефт оне).
III-3 Цанцел а мове
Ас а руле оф тхумб, до нот аллоw плаyерс то цанцел оне оф тхеир мовес. Цанцеллинг а мове цан цаусе манy иссуес, инцлудинг аллоwинг плаyерс то ревеал соме привате информатион интентионаллy.
Yоу цан аллоw а плаyер то цанцел а мове онлy иф хе ис ин тхе миддле оф а мултипле степс гаме ацтион анд иф но привате информатион хас беен ревеалед yет.
III-4 Аваилабле информатион
Еверy информатион висибле бy плаyерс ин тхе реал гаме схоулд бе аццессибле ин тхе адаптатион. Паy аттентион то соме информатион лике тхе нумбер оф цардс ин тхе оппонентс ханд, ор тхе нумбер оф ремаининг цардс ин тхе децк.
Иф ит ис еxплицитлy форбидден то цоунт цардс ин тхе дисцард пиле, со тхис информатион ис нот аваилабле.
Гаме тецхницал qуалитy
IV-1 Дон'т усе еxотиц стуфф
БГА Студио провидес а сет оф усефул тоолс то буилд боард гамес адаптатионс (и.е. цард манагемент, цонфирматион диалог, тоолтипс,…).
Усе тхем, анд дон'т усе еxотиц либрариес, плугинс ор трицкс.
Wхy? Бецаусе БГА Фрамеwорк wилл еволве ин тхе футуре то провиде неw феатурес то плаyерс, анд ит цоулд маке yоур гаме инцомпатибле wитх тхе неw версион.
Он тхе цонтрарy, иф yоу аре усинг стандард Хаггис усинг БГА стандард цард стуфф, yоу wилл ењоy тхесе енханцементс wитхоут анy еффорт.
Иф yоу феел тхат yоу реаллy неед соме еxотиц тхинг: дон'т хеситате то аск ус.
IV-2 Wрите ин (симпле) Енглисх
Соме отхер персон маy хаве то лоок он yоур цоде:
- Wе (БГА теам) аре хере то хелп yоу иф yоу неед ус
- Соме отхер БГА девелопер wантинг то хелп yоу
Фор алл тхесе реасонс, yоур цоде муст бе wриттен ин Енглисх (вариаблес, метходс,цомментс...).
Иф Енглисх ис нот yоур мотхер тонгуе дон'т бе афраид: тхе wхоле идеа хере ис то бе ундерстоод, нот то wрите ан ессаy :)
IV-3 Паге рефресх
А паге рефресх (Ф5) муст аллоw плаyерс то ресет тхе гаме интерфаце то а стабле стате ат анy момент оф тхе гаме.
БГА Студио фрамеwорк аллоwс yоу то до тхис wитх тхе « гетАллДатас » ПХП метход анд тхе « сетуп » Јавасцрипт метход.
Ноте: тхис « рефресх » феатуре ис алсо qуите усефул дуринг тхе девелопмент процесс:)
IV-4 Привате информатион
А привате гаме елемент муст бе висибле онлy то тхе плаyер оwнинг ит. Ит муст нот бе висибле бy хис оппонентс, бy анy меанс.
Ин партицулар:
- гетАллДатас ПХП метход муст нот ретурн анy елемент тхат аре хидден фром цуррент плаyер, евен иф тхе Јавасцрипт « сетуп » метход игнорес тхем.
- yоу муст нот сенд виа тхе « нотифyАллПлаyерс » фунцтион соме информатион тхат ис хидден фром оне плаyер (усе « нотифyПлаyер » инстеад).
Хеартс: еацх плаyер ис алертед абоут хис неw цардс усинг нотифyПлаyер, анд цардс фром тхе отхер плаyерс ремаинс сецрет
IV-5 Гаме прогрессион
Гаме прогрессион схоулд бе ас аццурате ас поссибле.
Оф цоурсе, итс нот алwаyс еасy (ор евен поссибле) то цомпуте гаме прогрессион, бут а вагуе аппроxиматион ис беттер тхан нотхинг.
Стоне Аге: тхере аре 2 дифферент енд гаме цондитионс (буилдинг цардс анд цивилизатион цардс).
Ботх аре такен инто аццоунт то инцреасе тхе аццурацy оф тхе гаме прогрессион.
IV-6 Гаме статистицс
Усинг БГА Студио yоу цан дефине а сет оф статистицс фор yоур гаме. Статистицс wилл бе дисплаyед ат тхе енд оф тхе гаме, анд хелп плаyерс то фигуре оут wхy тхеy wин/лоосе а гаме,
анд wхат тхеy схоулд импрове. Трy то цхоосе интерестинг статистицс тхат дистингуисх тхе дифферент стратегиес фор yоур гаме, ин ордер ит цан хелп плаyерс то ундерстанд тхеир гаме.
Сеасонс : статистицс
Суммарy
Тхесе гуиделинес аре хере то хелп yоу то маке суре тхат тхе плаyерс, тхе гаме публисхер анд тхе гаме аутхор аре гоинг то ењоy yоур адаптатион оф тхе гаме. Wе цреатед тхесе гуиделинес басед он оур персонал еxпериенце (wхицх инцлудес манy мистакес алонг тхе wаy) имплементинг а лот оф гамес он БГА платформ. Дон'т хеситате то цонтацт ус иф yоу феел унцомфортабле wитх оне оф тхесе гуиделинес ин соме партицулар цонтеxт wитх yоур гаме: тхесе гуиделинес аре хере то хелп анд нот то превент yоу то до смарт тхингс, анд хаве фун wхиле програминг yоур гаме ;)
Хеартс: еацх плаyер ис алертед абоут хис неw цардс усинг нотифyПлаyер, анд цардс фром тхе отхер плаyерс ремаинс сецрет