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

Pre-release checklist

From Board Game Arena
Revision as of 01:53, 25 January 2022 by Victoria La (talk | contribs)
Jump to navigation Jump to search

Game File Reference

Useful Components


  • 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.


Game Development Process

Guides for Common Topics

Miscellaneous Resources

If you think your game is ready to be reviewed by by BGA admins and/or Publisher (aka go to Alpha stage) please consult this checklist first

  • License
    • BGA must have a license for the game for a project to be moved to production, even to alpha. If you don't have license yet you can continue checking other stuff from the list below, but at the end it cannot be moved until license situation is cleared.
  • Metadata and graphics
    • Game_meta-information: has correct and up to date information about the game
    • Game box graphics is 3D version of the game box (if available) and publisher icon is correct (see Game art: img directory). Space around the box has to be transparent, not white.
    • You have added a game_banner.jpg and some game_displayX.jpg images to make the game page pretty (NB: on the studio, you have to create a build for these images to appear on the studio game page)
    • There are no images in the img directory that are not needed anymore
    • Multiple images (i.e. cards) are compressed in "Sprite" (see Game art: img directory)
    • Each image should not exceed 4M
    • Total size should not exceed 10M, image compression should be used otherwise (it also helps a lot to re-encode images as indexed palette vs RBG)
    • If you use extra fonts, they should be freeware (please include a .txt with the licence information)
  • Server side
    • When giving their turn to a player, you give them some extra time with the giveExtraTime() function
    • Game progression is implemented (getGameProgression() in php)
    • Zombie turn is implemented (zombieTurn() in php). Note: it can only be tested if you explicitly click on the quit button to create a zombie. If you are expelled it does not generated a Zombie.
    • You have defined and implemented some meaningful statistics for your game (i.e. total points, point from source A, B, C...)
    • Game has meaningful notification messages (but don't overkill it, more user logs will slow down the loading)
    • You implemented tiebreaking (using aux score field) and updated tiebreaker description in meta-data
  • Client side
    • Please check that you use ajaxcall only on player actions and never programmatically. Otherwise, your code will very likely create race conditions resulting in deadlocks or other errors.
  • Special testing
    • Game is tested with spectator (non player observer): change the testuser in the URL to see the game as another user (same URL as when clicking on red arrow). As a spectator, you should be able to see the game as if you were sitting beside of the players at a real table: all public information, no private information.
    • Game is tested with in-game replay from last move feature (by clicking on notification log items)
    • Game works in Chrome and Firefox browsers at least. Also very recommended to test in IE 11 and Edge.
    • Game works on mobile device (if you don't have mobile device to test at least test in Chrome with smaller screen, they have a mode for that)
    • Test your game in realtime mode. Usually people will run out of time if you use default times unless you add call giveExtraTime($active_player_id) before each turn
    • Test your game in 3D mode (if it makes sense; 3D mode can also be disabled through the 'enable_3d' parameter for, but if it "mostly works", it can be nice to keep it activated even if 2D is more appropriate for the game, just because it's fun to look at)
    • Check your game against the waiting screen, otherwise game start can fail. See Practical_debugging#Debugging_an_issue_with_the_waiting_screen
  • Cleanup
    • Remove all extra console.log from your js code
    • Remove all unnecessary debug logging from your php code
    • Copyright headers in all source files have your name
  • User Interface
    • Review BGA UI design Guidelines BGA_Studio_Guidelines
    • Check all your English messages for proper use of punctuation, capitalization, usage of present tense in notification (not past) and gender neutrality. See Translations for English rules.
    • If the elements in your game zone don't occupy all the available horizontal space, they should be centered.
    • If your game elements become blurry or pixellated when using the browser zoom, you may want to consider higher resolution images with background-size
    • Non-self explanatory graphic elements should have tooltips
    • If graphic elements appear in notification log they should have titles (i.e. title attribute of div) so can be read in non rendered form (i.e. as text only)
    • Strings in your source code are ready for translation. See Translations. You can generate dummy translations for checking that everything is ready for translation from your "Manage game" page.
    • A prefix for example a trigram for your game that you prepend to all the css classes to avoid namespace conflicts, i.e. vla_selected vs selected
    • If you are looking for advice on design and some 3rd party testing you can post a message on the developers forum, and ask other developers, there are a lot of people who will gladly do it.
  • Finally move to Alpha status
    • If possible (meaning if there is not already a project with that name) copy your project to a new project matching exactly the name of the game (no prefix or suffix). If not possible move on to the next steps, admin will have to retrieve the other project and overwrite it.
    • Create a build for your game from the "manage game" page (using the Build a new release version section) and check the log to make sure that everything builds fine (after a successful build, you should see a new version in "Versions available for production").
    • Send an e-mail to asking to move the project forward for Alpha/Review. You cannot deploy yourself from the "manage game" page until a first deploy has been done by the admins. If they don't reply in 3 days send email again, you can also nag on discord channel and forum until you get the attention.
    • When admins publish (push to alpha) they will send an email to the developer with all relevant information about the next steps.
  • Move from Alpha to Beta
    • Generally you have to have at least 10 revieweing with rank > 3.5 and not to many bugs open
    • It should be approved by publisher (or in some cases pubisher can review it in Beta)
    • Send an e-mail to asking to move the project forward for Beta