This is a documentation for Board Game Arena: play board games online !

Game metadata manager: Difference between revisions

From Board Game Arena
Jump to navigation Jump to search
No edit summary
 
(18 intermediate revisions by 5 users not shown)
Line 6: Line 6:


* [https://boardgamearena.com/controlpanelgames Game Metadata Manager (production)] - manage game tags and media once the game has reached private alpha and beyond
* [https://boardgamearena.com/controlpanelgames Game Metadata Manager (production)] - manage game tags and media once the game has reached private alpha and beyond
* [https://studio.boardgamearena.com/controlpanelgames Game Metadata Manager (studio)] - manage game media before the game reaches private alpha
* [https://studio.boardgamearena.com/controlpanelgames Game Metadata Manager (studio)] - manage game tags and media before the game reaches private alpha
 
Note: once your game is in private alpha, and you are using the production Game Metagata Manager, the metadata on studio is <i>never</i> updated.
 


Note: once your game is in private alpha, and you are using the production Game Metagata Manager, the metadata on studio is <i>never</i> automatically updated. On the studio game page, there is a button to pull metadata from production if you need to: "Sync metadata from production".
__TOC__
__TOC__


Line 26: Line 24:
|-
|-
| Box || [[File:Carcassonne_Box.png|frameless|Box]] ||
| Box || [[File:Carcassonne_Box.png|frameless|Box]] ||
* '''Required for public alpha'''
* PNG
* PNG
* It is displayed on the main site on the game description page and when creating a table (280x280 px).
* It is displayed on the main site on the game description page and when creating a table (280x280 px).
Line 31: Line 30:
* It is better to take the version of the game that is coherent with the game art used in the adaptation, and from the original publisher of the game.
* It is better to take the version of the game that is coherent with the game art used in the adaptation, and from the original publisher of the game.
* The background of the image must be transparent.
* The background of the image must be transparent.
* If you don't have a 3D version of the game box, you can use the following website to create one: http://www.3d-pack.com/
* If you don't have a 3D version of the game box, you can use the following website to create one: https://boxshot.com/3d-box/
* On Studio, you can only have one box image. Once deployed you can have a different box image for each language. This allows a localised image if you wish. If you don't provide a localised image, users will see the en box as a fallback.
|-
|-
| Icon || [[File:Carcassonne_Icon.png|frameless|Icon]] ||
| Icon || [[File:Carcassonne_Icon.png|frameless|Icon]] ||
* '''Required for public alpha'''
* PNG
* PNG
* It is the icon displayed in the lists of games and tables (50x50 px).
* It is the icon displayed in the lists of games and tables (50x50 px).
Line 40: Line 41:
|-
|-
| Title || [[File:Carcassonne_Title.png|frameless|Title]] ||
| Title || [[File:Carcassonne_Title.png|frameless|Title]] ||
* '''Required for beta'''
* PNG
* PNG
* max 2MB
* This is an image displayed instead of the name of the game as text
* This is an image displayed instead of the name of the game as text
* Must be 2000x2000px
* Must be 2000x2000px
* Must look good when overlayed on top of the game box, and must be transparent
* Must look good when overlayed on top of the game box, and must be transparent
* You can have a different title image for each language, so you can show a localised image if you wish (for example, "Stone Age" vs "L'Âge de Pierre"). If you don't provide a localised image, users will see the en title as a fallback. In this case, if the localised name differs from en, there will also be a subtitle showing the game's name in the user's locale.
* On Studio, you can only have one title image. Once deployed you can have a different title image for each language. This allows a localised image if you wish (for example, "Stone Age" vs "L'Âge de Pierre"). If you don't provide a localised image, users will see the en title as a fallback. In this case, if the localised name differs from en, there will also be a subtitle showing the game's name in the user's locale.
 
For guidelines on the positioning of elements of the title, see: [[Media:Title guidelines.png]].


⚠️ <b>Warning</b>: BGA are bit-by-bit adding titles to many games, and it's likely your released games are in the queue somewhere.
For guidelines on the positioning of elements of the title, see: [[Media:Title_guidelines.png]].
So, don't feel you need to rush to make a title. And, if you do make one now -- don't be surprised if it ends up getting replaced a little down the line.
|-
|-
| Publisher || - ||
| Publisher || - ||
* '''Optional''' (if there is no publisher)
* PNG
* PNG
* max 2MB
* It is the logo of the publisher of the game, displayed on the game description page.
* It is the logo of the publisher of the game, displayed on the game description page.
* The width must be 150 px. The height can be anything (reasonable). The image could be transparent.
* Must be 280x280px
* The image can be transparent.
* You can have up to 2 publisher images
* You can have up to 2 publisher images
|-
|-
| Banner || [[File:Carcassonne_Banner.jpg|frameless|Title]] ||
| Banner || [[File:Carcassonne_Banner.jpg|frameless|Title]] ||
* '''Required for beta'''
* JPG
* JPG
* max 2MB
* size 1386x400px
* size 1386x400px
* should not contain any text; representative of the atmosphere of the game such as a cover element or communication image; the box image covering the banner on the left should stand out
* should not contain any text; representative of the atmosphere of the game such as a cover element or communication image; the box image covering the banner on the left should stand out
|-
|-
| Display || - ||
| Display || - ||
* '''Required for release'''
* JPG
* JPG
* height between 400px and 760px, width maximum 1.5 x height;
* height between 400px and 760px, width maximum 1.5 x height;
Line 68: Line 74:
* the idea is to make players want to play the game, so it could be a zoomed card, some detail of the board, an overview of an ongoing physical game... but NOT a screenshot of the BGA adaptation since there is already the "see game in action" replay for that
* the idea is to make players want to play the game, so it could be a zoomed card, some detail of the board, an overview of an ongoing physical game... but NOT a screenshot of the BGA adaptation since there is already the "see game in action" replay for that
* You can have up to 10 display images
* You can have up to 10 display images
|-
| Major Variant || [[File:KoT Major Variant.png|frameless]]||
* '''Optional'''
* PNG
* size 280x280px
* Images used to accompany major options, see [[Game options and preferences: gameoptions.inc.php#option_level|Game options and preferences]]
|}
|}


== Tags ==
== Tags ==


Whilst working on your game on the studio initially, you can manage tags from the [[Game meta-information: gameinfos.inc.php|gameinfos.inc.php]] file.
Game tags should be managed through the Game Metadata Manager.
 
Before the game is published to production, this is done on the studio [https://studio.boardgamearena.com/controlpanelgames Game Metadata Manager (studio)] .
 
After release, the tags are copied over to the production site, and from this point on, all tag changes must be effectuated over there: [https://boardgamearena.com/controlpanelgames Game Metadata Manager (production)].
 
Please consider that for the '''Awarded game''' tag (Win a prestigious award), the game must have been at the '''first''' place of one the [http://boardgamegeek.com/wiki/page/Gaming_Industry_Awards# following major awards list].
 
== Metadata ==
Some text metadata is also managed through the Game Metadata Manager.
 
Before the game is published to production, this is done on the studio [https://studio.boardgamearena.com/controlpanelgames Game Metadata Manager (studio)] . After release, the metadata is copied over to the production site, and from this point on, all metadata changes must be effectuated over there: [https://boardgamearena.com/controlpanelgames Game Metadata Manager (production)].
 
====== Artist(s) and Designer(s) ======
The artists and designers of the game. These should be comma-separated lists in the case there is more than one.
 
====== Publication year ======
The year of first publication of the game. (Can be negative to represent BC.)
 
====== Complexity ======
Complexity of the game, from 0 (extremely simple) to 5 (extremely complex)
 
====== Luck ======
Luck of the game, from 0 (absolutely no luck in this game) to 5 (totally luck driven)
 
====== Strategy ======
Strategy of the game, from 0 (no strategy can be setup) to 5 (totally based on strategy)


Once your game first hits private alpha, the tags are copied over to the production site, and from this point on, all tag changes must be effectuated over there: [https://boardgamearena.com/controlpanelgames Game Metadata Manager (production)].
====== Diplomacy ======
Diplomacy of the game, from 0 (no interaction in this game) to 5 (totally based on interaction and discussion between players)


Note: this will change in the future to be more consistent.
====== Game page warning ======
If a specific warning is needed on the game page (to discuss and validate with admins) it can be displayed from the game infos. For example for Texas Hold'em:
There is no real money involved on BGA: this game has the mechanism of Poker but is using points instead of real money.
 
====== Custom "buy this game" button ======
By default, the "buy this game" button is a link to an Amazon search with the name of the game.
 
You can replace it by a different URL / game button label. The button label will be "Buy on <Name of the website>"
 
====== Description ======
Short game presentation text that will appear on the game description page, structured as an array of paragraphs.
 
Each paragraph should not contain html (plain text without formatting). A good length for this text is between 100 and 150 words (about 6 to 9 lines on a standard display.)
This wonderful game is about geometric shapes!
It was awarded best triangle game of the year in 2005 and nominated for the Spiel des Jahres.


== Migration ==
== Migration ==


Images used to be served from the[[Game art: img directory|/img]] folder of your game's repository. All of these files (those prefixed with <code>game_</code>) are now deprecated and can be deleted from the folder. Any changes to these images will not be picked up.
Metadata images used to be served from the [[Game art: img directory|/img]] folder of your game's repository. All of the image files prefixed with <code>game_</code> are now deprecated and can be deleted from the folder. Any changes to these images will not be picked up.
 
Tags used to be managed by changing the tags in [[Game meta-information: gameinfos.inc.php|gameinfos.inc.php]]. Any tags specified in this file are now ignored, and should not be specified. Tags must be edited using the [https://boardgamearena.com/controlpanelgames Game Metadata Manager].
 
Text metadata used to be managed by changing values in [[Game meta-information: gameinfos.inc.php|gameinfos.inc.php]]. Any of the deprecated fields specified in this file are now ignored, and you will be warned about them when using the "Reload game informations" button.
 
== Access Permissions ==


Tags used to be managed by changing the tags in [[Game meta-information: gameinfos.inc.php|gameinfos.inc.php]]. These tags are read only on the first deploy to production, from which point onwards tags must be editted using the [https://boardgamearena.com/controlpanelgames Game Metadata Manager] on production.
Currently, the GMM is available to developers and maintainers.


== Future ==
== Future ==
Line 89: Line 149:


It is planned that:
It is planned that:
* more metadata (such as publisher and designer names, or presentation text) be managed here
* more metadata (such as publisher) be managed her
* tags be managed exclusively this way (removing the initial dependency on gameinfos.inc.php)




[[Category:Studio]]
[[Category:Studio]]

Latest revision as of 03:17, 19 June 2024


Game File Reference


Useful Components

Official

  • Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
  • Draggable: a JS component to manage drag'n'drop actions.
  • Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
  • ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
  • Scrollmap: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games).
  • Stock: a JS component to manage and display a set of game elements displayed at a position.
  • Zone: a JS component to manage a zone of the board where several game elements can come and leave, but should be well displayed together (See for example: token's places at Can't Stop).

Undocumented component (if somebody knows please help with docs)

  • Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.

Unofficial


Game Development Process


Guides for Common Topics


Miscellaneous Resources
Game Metadata Manager Icon

The Game Metadata Manager is the portal for managing tags and media for your games. This page exists both on Production and Studio:

Note: once your game is in private alpha, and you are using the production Game Metagata Manager, the metadata on studio is never automatically updated. On the studio game page, there is a button to pull metadata from production if you need to: "Sync metadata from production".

Media

Game media consists of all the images which are used to represent your game on Board Game Arena, outside of the art of the actual game.

Whilst working on your game on the studio initially, you can manage media from the studio: Game Metadata Manager (studio).

Once your game first hits private alpha, the media is copied over to the production site, and from this point on, all media changes must be effectuated over there: Game Metadata Manager (production).

Name Example Description
Box Box
  • Required for public alpha
  • PNG
  • It is displayed on the main site on the game description page and when creating a table (280x280 px).
  • It should be a 3D image of a physical copy of the game box as it appears in an online shop.
  • It is better to take the version of the game that is coherent with the game art used in the adaptation, and from the original publisher of the game.
  • The background of the image must be transparent.
  • If you don't have a 3D version of the game box, you can use the following website to create one: https://boxshot.com/3d-box/
  • On Studio, you can only have one box image. Once deployed you can have a different box image for each language. This allows a localised image if you wish. If you don't provide a localised image, users will see the en box as a fallback.
Icon Icon
  • Required for public alpha
  • PNG
  • It is the icon displayed in the lists of games and tables (50x50 px).
  • The objective of this icon is to make the game recognizable among the other games. A good idea is to take a part of the game cover that is distinctive (ex: the game title).
  • This one does not have to be transparent. This image should not have a border
Title Title
  • Required for beta
  • PNG
  • max 2MB
  • This is an image displayed instead of the name of the game as text
  • Must be 2000x2000px
  • Must look good when overlayed on top of the game box, and must be transparent
  • On Studio, you can only have one title image. Once deployed you can have a different title image for each language. This allows a localised image if you wish (for example, "Stone Age" vs "L'Âge de Pierre"). If you don't provide a localised image, users will see the en title as a fallback. In this case, if the localised name differs from en, there will also be a subtitle showing the game's name in the user's locale.

For guidelines on the positioning of elements of the title, see: Media:Title_guidelines.png.

Publisher -
  • Optional (if there is no publisher)
  • PNG
  • max 2MB
  • It is the logo of the publisher of the game, displayed on the game description page.
  • Must be 280x280px
  • The image can be transparent.
  • You can have up to 2 publisher images
Banner Title
  • Required for beta
  • JPG
  • max 2MB
  • size 1386x400px
  • should not contain any text; representative of the atmosphere of the game such as a cover element or communication image; the box image covering the banner on the left should stand out
Display -
  • Required for release
  • JPG
  • height between 400px and 760px, width maximum 1.5 x height;
  • These images are displayed in a carousel on the game page
  • the idea is to make players want to play the game, so it could be a zoomed card, some detail of the board, an overview of an ongoing physical game... but NOT a screenshot of the BGA adaptation since there is already the "see game in action" replay for that
  • You can have up to 10 display images
Major Variant KoT Major Variant.png

Tags

Game tags should be managed through the Game Metadata Manager.

Before the game is published to production, this is done on the studio Game Metadata Manager (studio) .

After release, the tags are copied over to the production site, and from this point on, all tag changes must be effectuated over there: Game Metadata Manager (production).

Please consider that for the Awarded game tag (Win a prestigious award), the game must have been at the first place of one the following major awards list.

Metadata

Some text metadata is also managed through the Game Metadata Manager.

Before the game is published to production, this is done on the studio Game Metadata Manager (studio) . After release, the metadata is copied over to the production site, and from this point on, all metadata changes must be effectuated over there: Game Metadata Manager (production).

Artist(s) and Designer(s)

The artists and designers of the game. These should be comma-separated lists in the case there is more than one.

Publication year

The year of first publication of the game. (Can be negative to represent BC.)

Complexity

Complexity of the game, from 0 (extremely simple) to 5 (extremely complex)

Luck

Luck of the game, from 0 (absolutely no luck in this game) to 5 (totally luck driven)

Strategy

Strategy of the game, from 0 (no strategy can be setup) to 5 (totally based on strategy)

Diplomacy

Diplomacy of the game, from 0 (no interaction in this game) to 5 (totally based on interaction and discussion between players)

Game page warning

If a specific warning is needed on the game page (to discuss and validate with admins) it can be displayed from the game infos. For example for Texas Hold'em: 

There is no real money involved on BGA: this game has the mechanism of Poker but is using points instead of real money.
Custom "buy this game" button

By default, the "buy this game" button is a link to an Amazon search with the name of the game.

You can replace it by a different URL / game button label. The button label will be "Buy on <Name of the website>"

Description

Short game presentation text that will appear on the game description page, structured as an array of paragraphs.

Each paragraph should not contain html (plain text without formatting). A good length for this text is between 100 and 150 words (about 6 to 9 lines on a standard display.) 

This wonderful game is about geometric shapes!

It was awarded best triangle game of the year in 2005 and nominated for the Spiel des Jahres.

Migration

Metadata images used to be served from the /img folder of your game's repository. All of the image files prefixed with game_ are now deprecated and can be deleted from the folder. Any changes to these images will not be picked up.

Tags used to be managed by changing the tags in gameinfos.inc.php. Any tags specified in this file are now ignored, and should not be specified. Tags must be edited using the Game Metadata Manager.

Text metadata used to be managed by changing values in gameinfos.inc.php. Any of the deprecated fields specified in this file are now ignored, and you will be warned about them when using the "Reload game informations" button.

Access Permissions

Currently, the GMM is available to developers and maintainers.

Future

The Game Metadata Manager will play an increasingly important role in managing a BGA implementation in the future.

It is planned that:

  • more metadata (such as publisher) be managed her
Retrieved from "http:///index.php?title=Game_metadata_manager&oldid=21552"