Skip to content
Brad Root edited this page Apr 10, 2023 · 11 revisions

Page Overview

Pages are the core building block of Gamebook Engine.

Pages have three main components: the content, the decisions, and the consequences.

Pages also have an internal semi-optional attribute: type.

Type

By default, a page has no real type. But the first page of a game fulfills a special purpose and must be marked as such. There can only be one first page in a game.

Similarly, an "ending" page should also be marked, and it cannot have any decisions (since it is the end of the story).

Gamebook Engine does some validation to help you out: if the page type is "first" or "normal", it will warn you in multiple places if that page does not have any decisions. The page will be marked with a warning symbol in the tree view, and in the page editor there will be a warning telling you to create decisions or mark the page as an ending.

The Content

Page content is plain text formatted with Markdown. There's currently no real limit on how much content you can put in the page, excepting the database level list of what Core Data String type can hold.

Markdown Support

We use MarkdownKit for rendering in iOS, and its Markdown support is relatively limited, but the important things are supported:

*italic* or _italics_
**bold** or __bold__
~~strikethrough~~

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

> Quote

* List
- List
+ List

`code` or ```code```
[Links](http://github.com/ivanbruel/MarkdownKit/)

Decisions

Consequences

Clone this wiki locally