This is a documentation for Board Game Arena: play board games online !
Studio — разлика између измена
Пређи на навигацију
Пређи на претрагу
| (Није приказано 38 међуизмена 4 корисника) | |||
| Ред 1: | Ред 1: | ||
[[File:Bga_studio_small.jpg]] | [[File:Bga_studio_small.jpg]] | ||
Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the | Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available. | ||
== What is Board Game Arena Studio? == | == What is Board Game Arena Studio? == | ||
'''Board Game Arena Studio''' is a platform to build online board game | '''Board Game Arena Studio''' is a platform to build online board game adaptations using the Board Game Arena platform. | ||
It is open to any gamer with development skills :) | It is open to any gamer with software development skills :) | ||
BGA Studio website: http://en.studio.boardgamearena.com | |||
http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973 | |||
Original announcement on BGA forum: http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973 | |||
== Discover BGA Studio in 5 presentations == | == Discover BGA Studio in 5 presentations == | ||
| Ред 32: | Ред 33: | ||
Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine. | Then, you should checkout the [[First steps with BGA Studio]] to make sure that runs fine. | ||
After that, we advise you to take | After that, we strongly advise you to take one of these game creation tutorials: | ||
* [[Tutorial reversi]] | * [[Tutorial reversi]] - an abstract strategy game played on an 8×8 uncheckered board for 2 players | ||
* [[Tutorial gomoku]] | * [[Tutorial gomoku]] - an abstract strategy game tic-tac-toe style for 2 players | ||
* [[Tutorial hearts]] - a card game for 4 players | |||
Then start editing files and see what happens! ;) | Then start editing files and see what happens! ;) | ||
If you have any questions, please | Once you done with tutorials, you can start a real game (or join existing project) | ||
* [[Create a game in BGA Studio: Complete Walkthrough]] | |||
If you have any questions, please check out the '''[[Studio FAQ]]''' first, then if you didn't find the answer you were looking for, please post your question on the [http://forum.boardgamearena.com/viewforum.php?f=12 '''development forum''']. | |||
== BGA Studio documentation == | == BGA Studio documentation == | ||
=== BGA Studio Framework reference === | === BGA Studio Framework reference === | ||
This part of the documentation | This part of the documentation focuses on the development framework itself: functions and methods available to build your game. | ||
[[Studio file reference|File structure of a BGA game]] | [[Studio file reference|File structure of a BGA game]] | ||
==== Game logic ==== | ==== Game logic (Server side) ==== | ||
* [[Main game logic: yourgamename.game.php]] | * [[Main game logic: yourgamename.game.php]] | ||
| Ред 59: | Ред 62: | ||
* [[Game statistics: stats.inc.php]] | * [[Game statistics: stats.inc.php]] | ||
==== Game interface ==== | ==== Game interface (Client side) ==== | ||
* [[Game interface logic: yourgamename.js]] | * [[Game interface logic: yourgamename.js]] | ||
| Ред 65: | Ред 68: | ||
* [[Game interface stylesheet: yourgamename.css]] | * [[Game interface stylesheet: yourgamename.css]] | ||
* [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]] | * [[Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl]] | ||
* [[Your game mobile version]] | |||
==== Other components ==== | ==== Other components ==== | ||
| Ред 70: | Ред 74: | ||
* [[Translations]] (how to make your game translatable) | * [[Translations]] (how to make your game translatable) | ||
* [[Game options and preferences: gameoptions.inc.php]] | * [[Game options and preferences: gameoptions.inc.php]] | ||
* [[Game meta-information: gameinfos.inc.php]] | |||
* [[Game replay]] | * [[Game replay]] | ||
* [[3D]] | |||
=== BGA Studio game components reference === | === BGA Studio game components reference === | ||
| Ред 78: | Ред 84: | ||
* [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...). | * [[Deck]]: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...). | ||
* [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score). | * [[Counter]]: a JS component to manage a counter that can increase/decrease (ex: player's score). | ||
* [[Scrollmap]]: a JS component to manage a scrollable game area (useful when the game area can be infinite. Examples: Saboteur or Takenoko games). | * [[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. | * [[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). | * [[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) | |||
* [[Draggable]]: a JS component to manage drag'n'drop actions. | |||
* [[ExpandableSection]]: a JS component to manage a rectangular block of HTML than can be displayed/hidden. | |||
* [[Wrapper]]: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned. | |||
=== BGA Studio user guide === | === BGA Studio user guide === | ||
| Ред 89: | Ред 97: | ||
This part of the documentation is a user guide for the BGA Studio online development environment. | This part of the documentation is a user guide for the BGA Studio online development environment. | ||
[[Tools and tips of BGA Studio]] | * [[BGA game Lifecycle]] | ||
* [[First steps with BGA Studio]] | |||
[[Practical debugging]] | * [[Tutorial reversi]] | ||
* [[Tutorial gomoku]] | |||
[[Studio | * [[Tutorial hearts]] | ||
* [[Create a game in BGA Studio: Complete Walkthrough]] | |||
* [[Tools and tips of BGA Studio]] - Tips and instructions on setting up development environment | |||
* [[Practical debugging]] - Tips focused on debugging | |||
* [[Studio logs]] - Instructions for log access | |||
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks | |||
* [[BGA Studio Guidelines]] | |||
* [[Troubleshooting]] - Most common "I am really stuck" situations | |||
* [[Studio FAQ]] | |||
* [[Pre-release checklist]] - Go throught this list if you think you done development | |||
* [[Post-release phase]] | |||
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links | |||
== Other resources == | == Other resources == | ||
| Ред 99: | Ред 118: | ||
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum] | [http://forum.boardgamearena.com/viewforum.php?f=12 Development forum] | ||
[ | [https://en.boardgamearena.com/#!bugs Bug tracking system] | ||
Тренутна верзија на датум 18. април 2018. у 02:47
Note: Please DO NOT translate Studio Documentation, so that there can be one place where you can find the latest information available.
What is Board Game Arena Studio?
Board Game Arena Studio is a platform to build online board game adaptations using the Board Game Arena platform.
It is open to any gamer with software development skills :)
BGA Studio website: http://en.studio.boardgamearena.com
Original announcement on BGA forum: http://forum.boardgamearena.com/viewtopic.php?f=10&t=1973
Discover BGA Studio in 5 presentations
Why, how, what... to start discovering BGA Studio, we prepared 5 "powerpoint" presentations for you:
- 5 reasons why you should use BGA Studio for your online board game
- The 8 steps to create a board game on Board Game Arena
- The BGA Framework at a glance
- Focus on BGA game state machine
- BGA developers guidelines
How to join the BGA developer team?
Please see this page: How to join BGA developer team?
Great, I'm in! ... How should I start?
If you didn't already, check the presentations at the top of this page to get the basics.
Then, you should checkout the First steps with BGA Studio to make sure that runs fine.
After that, we strongly advise you to take one of these game creation tutorials:
- Tutorial reversi - an abstract strategy game played on an 8×8 uncheckered board for 2 players
- Tutorial gomoku - an abstract strategy game tic-tac-toe style for 2 players
- Tutorial hearts - a card game for 4 players
Then start editing files and see what happens! ;)
Once you done with tutorials, you can start a real game (or join existing project)
If you have any questions, please check out the Studio FAQ first, then if you didn't find the answer you were looking for, please post your question on the development forum.
BGA Studio documentation
BGA Studio Framework reference
This part of the documentation focuses on the development framework itself: functions and methods available to build your game.
Game logic (Server side)
- Main game logic: yourgamename.game.php
- Your game state machine: states.inc.php
- Game database model: dbmodel.sql
- Players actions: yourgamename.action.php
- Game material description: material.inc.php
- Game statistics: stats.inc.php
Game interface (Client side)
- Game interface logic: yourgamename.js
- Game art: img directory
- Game interface stylesheet: yourgamename.css
- Game layout: view and template: yourgamename.view.php and yourgamename_yourgamename.tpl
- Your game mobile version
Other components
- Translations (how to make your game translatable)
- Game options and preferences: gameoptions.inc.php
- Game meta-information: gameinfos.inc.php
- Game replay
- 3D
BGA Studio game components reference
Game components are useful tools you can use in your game adaptations.
- Deck: a PHP component to manage cards (deck, hands, picking cards, moving cards, shuffle deck, ...).
- Counter: a JS component to manage a counter that can increase/decrease (ex: player's score).
- 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)
- Draggable: a JS component to manage drag'n'drop actions.
- ExpandableSection: a JS component to manage a rectangular block of HTML than can be displayed/hidden.
- Wrapper: a JS component to wrap a <div> element around its child, even if these elements are absolute positioned.
BGA Studio user guide
This part of the documentation is a user guide for the BGA Studio online development environment.
- BGA game Lifecycle
- First steps with BGA Studio
- Tutorial reversi
- Tutorial gomoku
- Tutorial hearts
- Create a game in BGA Studio: Complete Walkthrough
- Tools and tips of BGA Studio - Tips and instructions on setting up development environment
- Practical debugging - Tips focused on debugging
- Studio logs - Instructions for log access
- BGA Studio Cookbook - Tips and instructions on using API's, libraries and frameworks
- BGA Studio Guidelines
- Troubleshooting - Most common "I am really stuck" situations
- Studio FAQ
- Pre-release checklist - Go throught this list if you think you done development
- Post-release phase
- BGA Code Sharing - Shared resources, projects on git hub, common code, other links