This is a documentation for Board Game Arena: play board games online !
Game metadata manager: Difference between revisions
No edit summary |
No edit summary |
||
(14 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Studio_Framework_Navigation}} | {{Studio_Framework_Navigation}} | ||
[[File:Game_Metadata_Manager_Icon.png|left|100px|link=|Game Metadata Manager Icon]] | |||
The <i>Game Metadata Manager</i> is the portal for managing tags and media for your games. This page exists both on Production and Studio: | The <i>Game Metadata Manager</i> is the portal for managing tags and media for your games. This page exists both on Production and Studio: | ||
Line 5: | Line 7: | ||
* [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 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> automatically updated. On the studio game page, there is a button to pull images from production if you need to: "Sync metadata images from production". | |||
Line 22: | Line 26: | ||
|- | |- | ||
| Box || [[File:Carcassonne_Box.png|frameless|Box]] || | | Box || [[File:Carcassonne_Box.png|frameless|Box]] || | ||
* 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). | ||
* It should be a 3D image of a physical copy of the game box as it appears in an online shop. | * It should be a 3D image of a physical copy of the game box as it appears in an online shop. | ||
Line 27: | Line 32: | ||
* 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: http://www.3d-pack.com/ | ||
* 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]] || | ||
* 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). | ||
* 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). | * 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). | ||
Line 34: | Line 41: | ||
|- | |- | ||
| Title || [[File:Carcassonne_Title.png|frameless|Title]] || | | Title || [[File:Carcassonne_Title.png|frameless|Title]] || | ||
* PNG | |||
* 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 | * 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 || - || | | Publisher || - || | ||
* PNG | |||
* 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. | ||
* | * 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]] || | ||
* JPG | |||
* 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 || - || | ||
* JPG | |||
* height between 400px and 760px, width maximum 1.5 x height; | * 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 | * 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 || - || | |||
* PNG | |||
* size 280x280px | |||
* Images used to accompany major options, see [[Game options and preferences: gameoptions.inc.php#option_level|Game options and preferences]] | |||
* NOTE: This is currently in development. You can set images and major options, but this feature is as yet invisible to users. | |||
|} | |} | ||
Line 58: | Line 79: | ||
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. | 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. | ||
Once your game first hits private alpha, the tags are copied over to the production site, and from this point on, all | 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)]. | ||
Note: this will change in the future to be more consistent. | Note: this will change in the future to be more consistent. | ||
Line 75: | Line 96: | ||
* more metadata (such as publisher and designer names, or presentation text) be managed here | * more metadata (such as publisher and designer names, or presentation text) be managed here | ||
* tags be managed exclusively this way (removing the initial dependency on gameinfos.inc.php) | * tags be managed exclusively this way (removing the initial dependency on gameinfos.inc.php) | ||
[[Category:Studio]] |
Revision as of 21:03, 28 November 2022
The Game Metadata Manager is the portal for managing tags and media for your games. This page exists both on Production and Studio:
- Game Metadata Manager (production) - manage game tags and media once the game has reached private alpha and beyond
- Game Metadata Manager (studio) - manage game 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 never automatically updated. On the studio game page, there is a button to pull images from production if you need to: "Sync metadata images 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 |
| |
Icon |
| |
Title |
For guidelines on the positioning of elements of the title, see: Media:Title guidelines.png. | |
Publisher | - |
|
Banner |
| |
Display | - |
|
Major Variant | - |
|
Tags
Whilst working on your game on the studio initially, you can manage tags from the gameinfos.inc.php file.
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: Game Metadata Manager (production).
Note: this will change in the future to be more consistent.
Migration
Images used to be served from the/img folder of your game's repository. All of these files (those 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. These tags are read only on the first deploy to production, from which point onwards tags must be editted using the Game Metadata Manager on production.
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 and designer names, or presentation text) be managed here
- tags be managed exclusively this way (removing the initial dependency on gameinfos.inc.php)