Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
- State requirements of Xcode 10 and iOS 12.
- Trim the scene update example in the Usage Guide, moving out the optional game controller update into the comments.
  • Loading branch information
ShinryakuTako committed Aug 6, 2018
1 parent 755c6af commit 6ec5847
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
9 changes: 6 additions & 3 deletions Documentation/Usage Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ redirect_from: "/Documentation/Usage%2Guide.html"

### 🍰 **To begin from a template**:

1. Download the [**OctopusKitQuickstart** Xcode project from the Releases page.][quickstart-project]
1. Download the [**OctopusKitQuickstart** Xcode project from the Releases page.][quickstart-project]

> You will require Xcode 10, and if you wish to run on a device, iOS 12 (both currently in beta.)
2. Build and run the project.

Expand Down Expand Up @@ -57,7 +59,6 @@ redirect_from: "/Documentation/Usage%2Guide.html"
super.update(currentTime)
guard !isPaused, !isPausedBySystem, !isPausedByPlayer, !isPausedBySubscene else { return }

OctopusKit.shared?.gameController.update(deltaTime: updateTimeDelta)
updateSystems(in: componentSystems, deltaTime: updateTimeDelta)
}
```
Expand All @@ -66,6 +67,8 @@ redirect_from: "/Documentation/Usage%2Guide.html"
> `componentSystems` is the default array of systems in every scene.
>
> Other steps are left for the subclass because each scene may need to handle these differently.
>
> If your game states also perform per-frame updates, then you must also call `OctopusKit.shared?.gameController.update(deltaTime: updateTimeDelta)`

----

Expand Down Expand Up @@ -166,7 +169,7 @@ systems.

- A **Subscene** is a node which may be added to a scene, but maintains its own hierarchy of entities and components. When a subscene is presented, the scene sets a special flag to pause the entities in the scene itself and any previous subscenes. This allows subscenes to be used for modal UI and content which must be overlaid on top of the scene's content, while pausing the main action without pausing the engine, so that only the topmost subscene will be updated.

> e.g.: In a game where the player can rummage through the hero's inventory, subscenes may be used to display the inventory while pausing the gameplay. Multiple subscenes may be used to let the player open smaller containers in the inventory, such as pouches inside a backpack, each displaying its contents over the parent container's UI. The engine ensures that only the topmost container's UI can be interacted with.
> e.g.: In a game where the player can rummage through the hero's inventory, subscenes may be used to display the inventory while pausing the gameplay. Multiple subscenes may be used to let the player open smaller containers in the inventory, such as pouches inside a backpack, each displaying its contents over the parent container's UI. The engine ensures that only the topmost container's UI can be interacted with.

### Tier 3

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Built upon Apple's SpriteKit, GameplayKit and Metal technologies.
4. [Getting Started](#getting-started)
5. [Etcetera](#etcetera) (license, contact)

🚀 *Eager to dive in? Download the [Quickstart project.][quickstart-project] (Xcode 9.4+)*
🚀 *Eager to dive in? Download the [Quickstart project][quickstart-project] (Xcode 10.)*

> This project is a result of trying to make my own games as a hobby. I love Swift but I couldn't find any engines that support it or had the kind of architecture that I wanted to work with, so I started making my own.
>
Expand Down Expand Up @@ -184,7 +184,7 @@ Set the custom class of the scene as `OctopusScene` or a subclass of it. Load th

## Getting Started

1. **Read the [Quickstart and Usage Guide.][usage-guide]** You will need Xcode 9.4 or 10.
1. **Read the [Quickstart and Usage Guide.][usage-guide]** You will need Xcode 10.

> **Skill Level: Intermediate**: Although OK is not presented in a form suitable for absolute beginners, mostly because I'm too lazy to write documentation from step zero, it's not "advanced" level stuff either; if you've read the [Swift Language Book][swift-book] and have attempted to make a SpriteKit game in Xcode, you are ready to use OK!
>
Expand Down

0 comments on commit 6ec5847

Please sign in to comment.