Docc docs

.gitignore

@@ -9,3 +9,4 @@ DerivedData/
 **/Source/pdex.dylib
 **/Source/pdex.elf
 build/
+.docc-build

README.md

@@ -32,7 +32,7 @@ Currently, the following sections of the API are implemented:
 - [x] System
 
 ## Usage
-For detailed instructions on how to get started creating a game using PlaydateKit, see [here](https://github.com/finnvoor/PlaydateKit).
+For detailed instructions on how to get started creating a game using PlaydateKit, see [here](https://finnvoor.github.io/PlaydateKit/documentation/playdatekit).
 
 1. Install a nightly [Swift](https://www.swift.org/download/#snapshots) toolchain that supports the Embedded experimental feature.
 2. Install the [Playdate SDK](https://play.date/dev/).

Sources/PlaydateKit/Documentation.docc/Documentation.md

@@ -0,0 +1,13 @@
+# ``PlaydateKit``
+
+@Metadata {
+ @PageImage(purpose: icon, source: "Logo")
+}
+
+Create games for Playdate using Swift.
+
+## Topics
+
+### Essentials
+
+- <doc:Meet-PlaydateKit>

Sources/PlaydateKit/Documentation.docc/Meet PlaydateKit.tutorial

@@ -0,0 +1,10 @@
+@Tutorials(name: "PlaydateKit") {
+ @Intro(title: "Meet PlaydateKit") {
+
+ }
+
+ @Chapter(name: "Your First Game") {
+ @TutorialReference(tutorial: "doc:Downloading-Prerequisites")
+ @TutorialReference(tutorial: "doc:Building-the-Template")
+ }
+}

Sources/PlaydateKit/Documentation.docc/Tutorials/Building the Template.tutorial

@@ -0,0 +1,37 @@
+@Tutorial(time: 10) {
+ @Intro(title: "Building the Template") {
+ This tutorial guides you through running your first game on the Playdate simulator using Swift.
+<!-- @Image(source: "", alt: "")-->
+ }
+
+ @Section(title: "Duplicate the PlaydateKit Template") {
+ @ContentAndMedia {}
+ @Steps {
+ @Step {
+ Navigate to the [PlaydateKitTemplate](https://github.com/finnvoor/PlaydateKitTemplate) GitHub repository.
+ @Image(source: "PlaydateKitTemplate", alt: "A screenshot of the PlaydateKitTemplate repository")
+ }
+ @Step {
+ Select **Use this Template > Create a new repository**.
+ @Image(source: "PlaydateKitTemplate Duplicate", alt: "A screenshot of the PlaydateKitTemplate repository")
+ }
+ @Step {
+ Give your new repository a name and select **Create repository**.
+ @Image(source: "PlaydateKitTemplate New", alt: "A screenshot of the PlaydateKitTemplate repository template info")
+ }
+ @Step {
+ Clone your new repository locally on your computer.
+ @Image(source: "PlaydateKitTemplate", alt: "A screenshot of the PlaydateKitTemplate repository")
+ }
+ }
+ }
+
+ @Section(title: "Rename your Game Package") {
+ @ContentAndMedia {
+ While you can stick with the snazzy "PlaydateKitTemplate" name, you probably want to rename your Swift Package to the name of your game.
+ }
+ @Step {
+ Coming soon...
+ }
+ }
+}

Sources/PlaydateKit/Documentation.docc/Tutorials/Downloading Prerequisites.tutorial

@@ -0,0 +1,42 @@
+@Tutorial(time: 10) {
+ @Intro(title: "Downloading Prerequisites") {
+ This tutorial guides you through downloading and installing the required tools needed to build games for Playdate using Swift.
+<!-- @Image(source: "", alt: "")-->
+ }
+
+ @Section(title: "Install the Playdate SDK") {
+ @ContentAndMedia {}
+ @Steps {
+ @Step {
+ Navigate to the [Playdate Developer page](https://play.date/dev/).
+ @Image(source: "Playdate SDK", alt: "A screenshot of the Playdate SDK download page")
+ }
+ @Step {
+ Agree to the Playdate SDK License, and select **Download Playdate SDK**.
+ @Image(source: "Playdate SDK Download", alt: "A screenshot of the Playdate SDK download page")
+ }
+ @Step {
+ Open and install the downloaded **PlaydateSDK.pkg**.
+ @Image(source: "Playdate SDK Finder", alt: "A screenshot of the Playdate SDK package")
+ }
+ }
+ }
+
+ @Section(title: "Install a Supported Swift Toolchain") {
+ PlaydateKit currently requires a recent nightly version of the Swift Toolchain that has support for the Embedded Swift experimental language feature.
+ @Steps {
+ @Step {
+ Navigate to the [Swift.org downloads page](https://www.swift.org/download/#snapshots).
+ @Image(source: "Swift Toolchain", alt: "A screenshot of the Swift Toolchain download page")
+ }
+ @Step {
+ Scroll to the **Trunk Development (main)** subsection, and select the **Xcode "Universal"** link to download the latest version of the Swift nightly toolchain.
+ @Image(source: "Swift Toolchain Download", alt: "A screenshot of the Swift Toolchain download page")
+ }
+ @Step {
+ Open and install the downloaded **swift-DEVELOPMENT-SNAPSHOT-202X-XX-XX-a-osx.pkg**.
+ @Image(source: "Swift Toolchain Finder", alt: "A screenshot of the Swift Toolchain package")
+ }
+ }
+ }
+}

docs/data/documentation/playdatekit.json

@@ -0,0 +1 @@
+{"identifier":{"url":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","interfaceLanguage":"swift"},"hierarchy":{"paths":[[]]},"sections":[],"metadata":{"title":"PlaydateKit","modules":[{"name":"PlaydateKit"}],"symbolKind":"module","role":"collection","images":[{"type":"icon","identifier":"Logo.png"}],"roleHeading":"Framework","externalID":"PlaydateKit"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/PlaydateKit\/tutorials\/Meet-PlaydateKit"],"title":"Essentials"},{"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame"],"generated":true,"title":"Protocols"},{"generated":true,"title":"Functions","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/posix_memalign(_:_:_:)"]},{"generated":true,"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Display","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/File","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Graphics","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/JSON","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Scoreboards","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Sprite","doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/System"],"title":"Type Aliases"},{"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate"],"generated":true,"title":"Enumerations"},{"title":"Extended Modules","generated":true,"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate"]}],"abstract":[{"type":"text","text":"Create games for Playdate using Swift."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/playdatekit"]}],"references":{"doc://PlaydateKit/documentation/PlaydateKit/System":{"kind":"symbol","type":"topic","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/System","title":"System","url":"\/documentation\/playdatekit\/system","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"System"}],"role":"symbol","abstract":[],"navigatorTitle":[{"text":"System","kind":"identifier"}]},"Logo.png":{"variants":[{"traits":["1x","light"],"url":"\/images\/PlaydateKit\/Logo.png"}],"alt":null,"type":"image","identifier":"Logo.png"},"doc://PlaydateKit/documentation/PlaydateKit/Display":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Display"}],"type":"topic","abstract":[],"title":"Display","role":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Display","url":"\/documentation\/playdatekit\/display","kind":"symbol","navigatorTitle":[{"text":"Display","kind":"identifier"}]},"doc://PlaydateKit/documentation/PlaydateKit/Playdate":{"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate","kind":"symbol","abstract":[],"title":"Playdate","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Playdate","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Playdate"}],"url":"\/documentation\/playdatekit\/playdate"},"doc://PlaydateKit/tutorials/Meet-PlaydateKit":{"type":"topic","title":"Meet PlaydateKit","abstract":[],"role":"overview","identifier":"doc:\/\/PlaydateKit\/tutorials\/Meet-PlaydateKit","url":"\/tutorials\/meet-playdatekit","kind":"overview"},"doc://PlaydateKit/documentation/PlaydateKit/CPlaydate":{"kind":"symbol","title":"CPlaydate","type":"topic","role":"collection","abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate","url":"\/documentation\/playdatekit\/cplaydate"},"doc://PlaydateKit/documentation/PlaydateKit/Graphics":{"url":"\/documentation\/playdatekit\/graphics","kind":"symbol","type":"topic","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Graphics","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Graphics"}],"navigatorTitle":[{"text":"Graphics","kind":"identifier"}],"abstract":[],"title":"Graphics"},"doc://PlaydateKit/documentation/PlaydateKit":{"abstract":[{"text":"Create games for Playdate using Swift.","type":"text"}],"images":[{"identifier":"Logo.png","type":"icon"}],"kind":"symbol","url":"\/documentation\/playdatekit","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","role":"collection","type":"topic","title":"PlaydateKit"},"doc://PlaydateKit/documentation/PlaydateKit/JSON":{"navigatorTitle":[{"kind":"identifier","text":"JSON"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/JSON","title":"JSON","url":"\/documentation\/playdatekit\/json","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"JSON","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://PlaydateKit/documentation/PlaydateKit/File":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"File"}],"type":"topic","title":"File","abstract":[],"role":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/File","url":"\/documentation\/playdatekit\/file","kind":"symbol","navigatorTitle":[{"text":"File","kind":"identifier"}]},"doc://PlaydateKit/documentation/PlaydateKit/posix_memalign(_:_:_:)":{"role":"symbol","abstract":[{"text":"Implement ","type":"text"},{"code":"posix_memalign(3)","type":"codeVoice"},{"type":"text","text":", which is required by the Swift runtime but is"},{"text":" ","type":"text"},{"type":"text","text":"not provided by the Playdate C library."}],"title":"posix_memalign(_:_:_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"posix_memalign"},{"text":"(","kind":"text"},{"text":"UnsafeMutablePointer","kind":"typeIdentifier","preciseIdentifier":"s:Sp"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UnsafeMutableRawPointer","preciseIdentifier":"s:Sv"},{"text":"?>, ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:s4CInta","kind":"typeIdentifier","text":"CInt"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/posix_memalign(_:_:_:)","type":"topic","kind":"symbol","url":"\/documentation\/playdatekit\/posix_memalign(_:_:_:)"},"doc://PlaydateKit/documentation/PlaydateKit/PlaydateGame":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PlaydateGame"}],"navigatorTitle":[{"text":"PlaydateGame","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/playdatekit\/playdategame","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame","title":"PlaydateGame","kind":"symbol","abstract":[]},"doc://PlaydateKit/documentation/PlaydateKit/Sprite":{"url":"\/documentation\/playdatekit\/sprite","title":"Sprite","role":"symbol","kind":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Sprite","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Sprite","kind":"identifier"}],"navigatorTitle":[{"text":"Sprite","kind":"identifier"}]},"doc://PlaydateKit/documentation/PlaydateKit/Scoreboards":{"title":"Scoreboards","kind":"symbol","role":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Scoreboards","url":"\/documentation\/playdatekit\/scoreboards","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Scoreboards","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Scoreboards"}]}}}