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

Khác biệt giữa bản sửa đổi của “Studio”

Từ Board Game Arena
Bước tới điều hướng Bước tới tìm kiếm
 
(Không hiển thị 6 phiên bản của 2 người dùng ở giữa)
Dòng 39: Dòng 39:


Then start editing files and see what happens! ;)
Then start editing files and see what happens! ;)
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'''].
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'''].
Dòng 74: Dòng 77:
* [[Game replay]]
* [[Game replay]]
* [[3D]]
* [[3D]]
* [[Some usual board game elements image ressources]]


=== BGA Studio game components reference ===
=== BGA Studio game components reference ===
Dòng 81: Dòng 85:
* [[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).
* [[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.
* [[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.
* [[Wrapper]]: a JS component to wrap a  <div> element around his child, even if these elements are absolute positioned.
* [[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 ===
Dòng 102: Dòng 108:
* [[Studio logs]] - Instructions for log access
* [[Studio logs]] - Instructions for log access
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
* [[BGA Studio Cookbook]] - Tips and instructions on using API's, libraries and frameworks
* [[BGA Studio Guidelines]]
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [[Troubleshooting]] - Most common "I am really stuck" situations
* [[Studio FAQ]]
* [[Studio FAQ]]
* [[Pre-release checklist]] - Go throw this list if you think you done development
* [[Pre-release checklist]] - Go throught this list if you think you done development
* [[Post-release phase]]
* [[Post-release phase]]
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links
* [[BGA Code Sharing]] - Shared resources, projects on git hub, common code, other links
Dòng 111: Dòng 118:


[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]
[http://forum.boardgamearena.com/viewforum.php?f=12 Development forum]
[http://forum.boardgamearena.com/viewforum.php?f=4 Bugs forum] ?? what is this


[https://en.boardgamearena.com/#!bugs Bug tracking system]
[https://en.boardgamearena.com/#!bugs Bug tracking system]

Bản mới nhất lúc 11:45, ngày 7 tháng 3 năm 2019

Bga studio small.jpg

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:

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:

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.

File structure of a BGA game

Game logic (Server side)

Game interface (Client side)

Other components

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.

Other resources

Development forum

Bug tracking system