OctopusKit Game Project Template

July 2, 2020 · View on GitHub

Template and tutorial for the OctopusKit game engine.

🆕 In Xcode 12 or later, create a new App project, and choose Interface: SwiftUI.

❗️ Do NOT create a "Game" project, because that template does not use SwiftUI.

OctopusKit targets iOS/iPadOS/tvOS 14 and macOS Big Sur, but you may be able to get it to run with Xcode 11, iOS 13 and Catalina.
📦 Add OctopusKit as a Swift Package Manager Dependency.

Xcode File menu » Swift Packages » Add Package Dependency...

Enter the URL for the GitHub repository.

Download the "develop" branch for the latest version.
📥 Copy and include all the subfolders from the Templates/Game/Shared folder in your project.

In the Xcode Project Navigator, select the OctopusKit/Templates/Game folder, then in the File Inspector, click the arrow next to "Full Path", then drag all the subfolders (Components, Core, Entities etc.) from the Shared subfolder into your project's Shared folder in the Xcode navigator.
🖼 Add the GameContentView to the ContentView.swift file:
```
var body: some View {
    GameContentView()
}
```
🚀 Build and run the project to verify that the template works.
👓 Examine the various files to see how everything works, then modify the template for your specific game.
Check the documentation:
- For a detailed explanation of the engine architecture, see Architecture.md in the Documentation folder of the OctopusKit package/repository.
- To see how to do common tasks, refer to Usage Guide.md