Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Readme with App Store Link #48

Merged
merged 1 commit into from
Apr 10, 2023
Merged

Update Readme with App Store Link #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 11 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,19 @@ Gamebook Engine is an iOS app for creating and playing gamebooks, a type of inte

![Gamebook Engine Screenshots](/images/github-screenshots.jpg?raw=true)

## Download

- [Download Gamebook Engine for iOS 15.6 and later on the App Store](https://apps.apple.com/us/app/gamebook-engine/id1478537871)

## Beta Test

If you're interested in using pre-release versions of Gamebook Engine and providing feedback, you can join the beta!

**[Sign up for the beta on TestFlight](https://testflight.apple.com/join/FjHHmoVy)**

## Gamebook Structure

* **Attributes**
* These are essentially just global variables shared throughout a game
* They hold a name, and an decimal value which defaults to 0.0
* **Pages**
* **Content**
* The text of the page, formatted with a limited set of Markdown attributes
* **Consequences**
* Method for manipulating a player's stored attributes
* A consequence can affect attributes in three ways:
* Set (to a value)
* Increment (by a value)
* Decrement (by a value)
* Multiply (by a value)
* **Decisions**
* **Destination**
* The page that the decision leads to
* **Rules**
* Match Any or All rules (based on the value of Attributes) to determine if a decision appears on the page

If you're curious about what an exported Gamebook looks like, view [An Introduction to Gamebook Engine.gbook](https://github.com/amiantos/gamebookengine/blob/master/GamebookEngine/Built-in%20Gamebooks/An%20Introduction%20to%20Gamebook%20Engine.gbook) as a simple example.

## To Install
- [Sign up for the beta on TestFlight](https://testflight.apple.com/join/FjHHmoVy)

## Learn More

- [Check out the Gamebook Engine wiki](https://github.com/amiantos/gamebookengine/wiki)

## Development

1. `git clone https://github.com/amiantos/gamebookengine.git`
2. Open `GamebookEngine.xcproject` in Xcode 14.2 or higher.
Expand Down