BoxPlanet Game Framework (BGF) Documentation
This documentation set presents the current implementation of the BoxPlanet Game Framework (BGF).
It is written for clients who want to understand what kinds of games, stories, encounters, and progression systems can be built with BGF without needing to work directly with code.
Recommended Reading Order
- BGF Overview
- Game Flow
- Campaigns and Maps
- Objectives and Win Conditions
- Actors and Progress
- Items, Equipment, and Inventory
- Cards and Power Growth
- Variants and Launcher
Visual Attachments
- BGF Launcher-to-Campaign Flow
- BGF Campaign Branching Flow
- BGF Map Type Overview
- BGF Objective and Win-Condition Matrix
- BGF Actor / Item / Card Relationship
- BGF Documentation Colour Scheme
What This Set Covers
- What BGF can support for story-driven action games
- How campaigns, maps, characters, items, and card systems can be used
- What kinds of win conditions, fail conditions, and progression structures are available
- How different branded games can be built on the same framework
What This Set Does Not Try To Do
- It is not a code manual
- It is not an editor guide
- It does not document every internal implementation detail
- BGF is actively being develop so it is not the most up-to-date documentation of the BGF.
The goal is simple: help you, the client, understand what you can ask BGF to do when designing a game concept, story flow, and gameplay structure.