-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
660 changed files
with
1,111 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,3 +9,4 @@ DerivedData/ | |
**/Source/pdex.dylib | ||
**/Source/pdex.elf | ||
build/ | ||
.docc-build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# ``PlaydateKit`` | ||
|
||
@Metadata { | ||
@PageImage(purpose: icon, source: "Logo") | ||
} | ||
|
||
Create games for Playdate using Swift. | ||
|
||
## Topics | ||
|
||
### Essentials | ||
|
||
- <doc:Meet-PlaydateKit> |
10 changes: 10 additions & 0 deletions
10
Sources/PlaydateKit/Documentation.docc/Meet PlaydateKit.tutorial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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") | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+850 KB
Sources/PlaydateKit/Documentation.docc/Resources/Playdate SDK Download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+218 KB
Sources/PlaydateKit/Documentation.docc/Resources/Playdate SDK Finder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+616 KB
Sources/PlaydateKit/Documentation.docc/Resources/PlaydateKitTemplate Duplicate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+483 KB
Sources/PlaydateKit/Documentation.docc/Resources/PlaydateKitTemplate New.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+570 KB
Sources/PlaydateKit/Documentation.docc/Resources/PlaydateKitTemplate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+496 KB
Sources/PlaydateKit/Documentation.docc/Resources/Swift Toolchain Download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+441 KB
Sources/PlaydateKit/Documentation.docc/Resources/Swift Toolchain Finder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions
34
Sources/PlaydateKit/Documentation.docc/Tutorials/Building the Template.tutorial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
@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. | ||
} | ||
} | ||
} |
42 changes: 42 additions & 0 deletions
42
Sources/PlaydateKit/Documentation.docc/Tutorials/Downloading Prerequisites.tutorial
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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") | ||
} | ||
} | ||
} | ||
} |
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"abstract":[{"type":"text","text":"Create games for Playdate using Swift."}],"hierarchy":{"paths":[[]]},"metadata":{"images":[{"identifier":"Logo.png","type":"icon"}],"externalID":"PlaydateKit","role":"collection","title":"PlaydateKit","symbolKind":"module","roleHeading":"Framework","modules":[{"name":"PlaydateKit"}]},"identifier":{"url":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Essentials","identifiers":["doc:\/\/PlaydateKit\/tutorials\/Meet-PlaydateKit"]},{"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame"],"generated":true,"title":"Protocols"},{"title":"Functions","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/posix_memalign(_:_:_:)"],"generated":true},{"title":"Type Aliases","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"],"generated":true},{"title":"Enumerations","generated":true,"identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate"]},{"generated":true,"title":"Extended Modules","identifiers":["doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate"]}],"variants":[{"paths":["\/documentation\/playdatekit"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://PlaydateKit/documentation/PlaydateKit/CPlaydate":{"type":"topic","abstract":[],"role":"collection","kind":"symbol","title":"CPlaydate","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/CPlaydate","url":"\/documentation\/playdatekit\/cplaydate"},"doc://PlaydateKit/documentation/PlaydateKit/PlaydateGame":{"navigatorTitle":[{"text":"PlaydateGame","kind":"identifier"}],"url":"\/documentation\/playdatekit\/playdategame","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/PlaydateGame","type":"topic","abstract":[],"kind":"symbol","role":"symbol","title":"PlaydateGame","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"PlaydateGame","kind":"identifier"}]},"Logo.png":{"variants":[{"url":"\/images\/PlaydateKit\/Logo.png","traits":["1x","light"]}],"identifier":"Logo.png","alt":null,"type":"image"},"doc://PlaydateKit/documentation/PlaydateKit/posix_memalign(_:_:_:)":{"abstract":[{"type":"text","text":"Implement "},{"type":"codeVoice","code":"posix_memalign(3)"},{"text":", which is required by the Swift runtime but is","type":"text"},{"text":" ","type":"text"},{"text":"not provided by the Playdate C library.","type":"text"}],"title":"posix_memalign(_:_:_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"posix_memalign","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sp","text":"UnsafeMutablePointer"},{"text":"<","kind":"text"},{"text":"UnsafeMutableRawPointer","kind":"typeIdentifier","preciseIdentifier":"s:Sv"},{"kind":"text","text":"?>, "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4CInta","text":"CInt"}],"kind":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/posix_memalign(_:_:_:)","url":"\/documentation\/playdatekit\/posix_memalign(_:_:_:)","type":"topic","role":"symbol"},"doc://PlaydateKit/documentation/PlaydateKit/System":{"url":"\/documentation\/playdatekit\/system","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"System","kind":"identifier"}],"kind":"symbol","title":"System","abstract":[],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/System","role":"symbol","navigatorTitle":[{"text":"System","kind":"identifier"}],"type":"topic"},"doc://PlaydateKit/documentation/PlaydateKit/Sprite":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Sprite","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","url":"\/documentation\/playdatekit\/sprite","navigatorTitle":[{"kind":"identifier","text":"Sprite"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Sprite","title":"Sprite","role":"symbol"},"doc://PlaydateKit/tutorials/Meet-PlaydateKit":{"identifier":"doc:\/\/PlaydateKit\/tutorials\/Meet-PlaydateKit","abstract":[],"kind":"overview","type":"topic","url":"\/tutorials\/meet-playdatekit","role":"overview","title":"Meet PlaydateKit"},"doc://PlaydateKit/documentation/PlaydateKit/File":{"title":"File","navigatorTitle":[{"kind":"identifier","text":"File"}],"url":"\/documentation\/playdatekit\/file","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"File","kind":"identifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/File","type":"topic","role":"symbol"},"doc://PlaydateKit/documentation/PlaydateKit/Playdate":{"navigatorTitle":[{"text":"Playdate","kind":"identifier"}],"url":"\/documentation\/playdatekit\/playdate","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Playdate","type":"topic","abstract":[],"kind":"symbol","role":"symbol","title":"Playdate","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Playdate"}]},"doc://PlaydateKit/documentation/PlaydateKit/Display":{"kind":"symbol","title":"Display","navigatorTitle":[{"kind":"identifier","text":"Display"}],"type":"topic","abstract":[],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Display"}],"url":"\/documentation\/playdatekit\/display","role":"symbol","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Display"},"doc://PlaydateKit/documentation/PlaydateKit/JSON":{"title":"JSON","type":"topic","url":"\/documentation\/playdatekit\/json","navigatorTitle":[{"text":"JSON","kind":"identifier"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"JSON","kind":"identifier"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/JSON","abstract":[]},"doc://PlaydateKit/documentation/PlaydateKit":{"url":"\/documentation\/playdatekit","abstract":[{"text":"Create games for Playdate using Swift.","type":"text"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit","title":"PlaydateKit","kind":"symbol","role":"collection","images":[{"identifier":"Logo.png","type":"icon"}],"type":"topic"},"doc://PlaydateKit/documentation/PlaydateKit/Scoreboards":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Scoreboards","kind":"identifier"}],"url":"\/documentation\/playdatekit\/scoreboards","navigatorTitle":[{"kind":"identifier","text":"Scoreboards"}],"identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Scoreboards","abstract":[],"kind":"symbol","title":"Scoreboards"},"doc://PlaydateKit/documentation/PlaydateKit/Graphics":{"type":"topic","identifier":"doc:\/\/PlaydateKit\/documentation\/PlaydateKit\/Graphics","navigatorTitle":[{"kind":"identifier","text":"Graphics"}],"url":"\/documentation\/playdatekit\/graphics","abstract":[],"role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Graphics","kind":"identifier"}],"title":"Graphics","kind":"symbol"}}} |
Oops, something went wrong.