Swift wrapper for the Ink narrative scripting language. Based on InkJS. Requires JavaScriptCore (so no Linux support).
- Loading Ink stories
loadStory(json: String); - Basic flow: continue story
continueStory()and choiceschooseChoiceIndex(_ index: Int); - Moving to knots/stitches
moveToKnitStitch(_ knot: String, stitch: String? = nil); - Tag support. Read
currentTagsvariable; - Setting and getting variable values (supports strings, 32-bit integers and doubles);
- Loading and saving state
stateToJSON()andloadState(_ jsonDataString: String); - Combine integration (subscribe to state changes, observe variables).
- InkSwift uses JavascriptCore. This means that only Apple platforms are supported. I'm working on Linux support using SwiftJS, but there is a bug that makes it unusable at this time.
Add InkSwift as a dependency to Package.swift:
Start by creating a InkStory
let story = InkStory()
Then load a story from a Ink JSON (you can use Inklecate or Inky to convert an .Ink file to a .json file.): let storyJSON = ... // story.loadStory(json: storyJSON)
A very cool
InkStory conforms to the ObservableObject protocol. This makes using it in Combine possible and SwiftUI very easy. A simple example SwiftUI view that can play an Ink story would contain:
Add
import SwiftInk
to ContentView.swift
Add the following property to your ContentView:
@StateObject var story = InkStory()
Note: change the filename to load to your own JSON file. Don't forget to add it to the project.
func loadStory() {
guard let url = Bundle.main.url(forResource: "test.ink", withExtension: "json") else {
fatalError("Could not find ink story file.")
}
guard let storyJSON = try? String(contentsOf: url) else {
fatalError("Could not load story file.")
}
story.loadStory(json: storyJSON)
}
var body: some View {
VStack {
Text(story.currentText)
if story.canContinue {
Button("Continue") {
story.continueStory()
}
}
ForEach(story.options, id: \.index) { option in
Button(option.text) {
story.chooseChoiceIndex(option.index)
}
}
}.padding()
.onAppear {
loadStory()
}
}
- The Ink runtime uses the official Ink Javascript port InkJS