BGA Code Sharing

Game File Reference

Overview

• dbmodel.sql - database model
• gameinfos.inc.php - meta-information
• gameoptions.json - game options & user preferences
• img/ - game art
• Game Metadata Manager - tags and metadata media
• material.inc.php - static data
• misc/ - studio-only storage
• modules/ - additional game code
• states.inc.php - state machine
• stats.json - statistics
• X.action.php - player actions
• X.css - interface stylesheet
• Game.php - main logic
• X.js - interface logic
• X.view.php - dynamic game layout
• X_X.tpl - static game layout

---

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

• BGA Code Sharing - Shared resources, projects on git hub, common code, other links
• BGA Studio Cookbook - Tips and instructions on using API's, libraries and frameworks
• Common board game elements image resources

---

Game Development Process

• First steps with BGA Studio
• Create a game in BGA Studio: Complete Walkthrough
• Tutorial reversi
• Tutorial gomoku
• Tutorial hearts
• BGA Studio Guidelines
• BGA game Lifecycle
• Pre-release checklist
• Post-release phase
• Player Resources - add player help/rules to your game page

---

Guides for Common Topics

• Translations - make your game translatable
• Game Replay
• Mobile Users
• 3D
• Compatibility

---

Miscellaneous Resources

• Studio FAQ
• Tools and tips of BGA Studio - Tips and instructions on setting up development environment
• Studio logs - Instructions for log access
• Practical debugging - Tips focused on debugging
• Troubleshooting - Most common "I am really stuck" situations
• Studio Bugs - Reports against Studio itself (not BGA!)

This page is for listing of externally hosted bga projects, tools and resources, as well as internal project intended for sharing

Projects hosted not in studio

See the table a link and nickname of the developer on bga (same as used for dev forum), and short description

Important notice about artwork on BGA Open Source projects: original hi-resolution images from publishers must not be published on the repositories. In addition, it is better to specify that the images derivated from publishers artwork are copyrighted and cannot be licensed under a free license like Creative Commons.

NON-GAME PROJECTS	CODE LINK	DEVELOPER
Shared Code (not a game)	https://github.com/elaskavaia/bga-sharedcode	Victoria_La
BoardGameArena Workbench (not a game)	https://github.com/danielholmes/bga-workbench	Daniel Holmes (dhau)
GAME	CODE LINK	DEVELOPER
Assyria	https://github.com/sebastien-prudhomme/bga-assyria	daikinee
The Battle for Hill 218	https://github.com/danielholmes/battle-for-hill-218	Daniel Holmes (dhau)
Bonbons	https://github.com/AntonioSoler/bga-bonbons	Morgalad
Coup: City State	https://github.com/quietmint/bga-coupcitystate	quietmint
Eruption	https://github.com/AndyKerrison/bga-eruption	Andy_K
Florenza: The Card Game	https://github.com/alberto-bottarini/bga-florenza	tarini
Hearts (Tutorial)	https://github.com/elaskavaia/bga-heartsla	Victoria_La
Incan Gold	https://github.com/AntonioSoler/bga-incangold	Morgalad
Marco Polo	https://github.com/rcitaliano/MarcoPolo	rcitaliano
Nile	https://github.com/AndyKerrison/bga-nile	Andy_K
Noir: Killer vs Inspector	https://bitbucket.org/chhuang76/bga_noirkvi	ch huang
Penny Press	https://github.com/AdamNovotny/bga-blooms	A-dam
P.I.	https://gitlab.com/fa81/bga-pi, https://github.com/hellp/bga-pi (mirror)	Fabian Neumann (fa81)
Tablut	https://github.com/Lucas-C/tablut	Lucas-C & ntaffore
Takara Island	https://github.com/AntonioSoler/bga-takaraisland	Morgalad
Teotihuacan: City of Gods	https://github.com/Trompetenhut/bga-teotihuacan	Trompetenhut

Projects on studio

Links to studio project which owner wish share as read only. Project owner please add you project here, dev nickname and short description if you would like to share it. For the projects below any developer can add themselves to a project as read-only from http://en.studio.boardgamearena.com/#!projects page.

NAME	CODE LINK	DEVELOPER
Shared Code	http://en.studio.boardgamearena.com/#!studiogame?game=sharedcode	Victoria_La
Original BGA template	http://en.studio.boardgamearena.com/#!studiogame?game=template	Victoria_La

Other useful resources

• Archive of tutorial projects https://www.dropbox.com/s/rsd5r4v49xudpp0/Studio.zip?dl=0
  • Note: Hearts project is corrupted there, use Hearts tutorial project above
• Website with bunch of textures and sounds http://www.grsites.com/archive/textures/
• Shrink images without loss of quality https://tinypng.com/ or http://www.iloveimg.com/ (recommended by Gregory Isabelli)
• CSS shapes https://css-tricks.com/examples/ShapesOfCSS/
• PDF Scraper - extract images - http://www.extractpdf.com/
• BoardGameArena Workbench - set of tools to help test and deploy BGA projects - https://github.com/danielholmes/bga-workbench