https://github.com/finnvoor/PlaydateKit

Create games for Playdate using Swift.
https://github.com/finnvoor/PlaydateKit

game-development playdate playdate-sdk swift

Last synced: 3 months ago
JSON representation

Create games for Playdate using Swift.

• Host: GitHub
• URL: https://github.com/finnvoor/PlaydateKit
• Owner: finnvoor
• License: cc0-1.0
• Created: 2024-03-13T22:39:51.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-13T21:21:52.000Z (9 months ago)
• Last Synced: 2024-04-14T12:03:53.900Z (9 months ago)
• Topics: game-development, playdate, playdate-sdk, swift
• Language: Swift
• Homepage: https://finnvoor.github.io/PlaydateKit/documentation/playdatekit
• Size: 14.3 MB
• Stars: 92
• Watchers: 4
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





    

        

    

    

        

    

    

        

    



# PlaydateKit

PlaydateKit provides easy to use Swift bindings for the [Playdate](https://play.date/) C API. PlaydateKit aims to be as Swift-y as possible, replacing error pointers with throwable functions, avoiding the use of pointers and memory management as much as possible, and adding documentation comments to all functions (copied from the Playdate SDK docs).

## Status

PlaydateKit provides (almost) full coverage of the Playdate C API. PlaydateKit adds wrapper types for some values (Sprite, Bitmap, FileHandle, etc) that automatically manage the allocation/deallocation of resources. While I have attempted to closely follow the C API specifications, much of it is untested, so if you run into an unexpected issue or can't do something with the Swift API, please open an issue!

Currently, the following sections of the API are implemented:

- [x] Display

- [x] File

- [x] Graphics

- [x] JSON

- [ ] Lua

- [x] Scoreboards

- [ ] Sound

  - [x] FilePlayer

  - [x] SamplePlayer

  - [x] Synth (partial)

- [x] Sprite

- [x] System

## Usage

For detailed instructions and documentation on how to get started creating a game using PlaydateKit, see [here](https://finnvoor.github.io/PlaydateKit/documentation/playdatekit).

### Summary

1. Install a recent nightly [Swift](https://www.swift.org/download/#snapshots) toolchain that supports the Embedded experimental feature.

2. Install the [Playdate SDK](https://play.date/dev/).

3. Create a new repository using the [PlaydateKitTemplate template](https://github.com/finnvoor/PlaydateKitTemplate).

5. Build and run directly in the simulator using Xcode, or build using the command `swift package pdc`. When built using `swift package pdc`, the built `pdx` game file will be located at `.build/plugins/PDCPlugin/outputs/PlaydateKitTemplate.pdx` and can be opened in the Playdate simulator.

Your `PlaydateGame` object manages the game lifecycle, receiving events such as `gameWillPause` and `deviceWillSleep`. 

```swift

import PlaydateKit

final class Game: PlaydateGame {

    init() {

        System.addCheckmarkMenuItem(title: "check me") { isChecked in

            print(isChecked ? "checked!" : "not checked")

        }

    }

    func update() -> Bool {

        System.drawFPS()

        return true

    }

    func gameWillPause() {

        print("Paused!")

    }

}

```

## Contributing

I'm happy to accept contributions on this project, whether it's bug fixes, implementing missing features, or opening an issue. Please try to follow the existing conventions/style in the project.

If you create a game using PlaydateKit and would like it featured here, please open an issue or pull request! If you would like to demake a retro game or create a new one that demonstrates PlaydateKit's capabilities, feel free to add an example game in the `Examples/` directory.

## Acknowledgements

PlaydateKit was inspired by and would not be possible without the excellent work done by [@rauhul](https://github.com/rauhul) on [swift-playdate-examples](https://github.com/apple/swift-playdate-examples). Specifically, PlaydateKit was created due to the note in the swift-playdate-examples repo: 

> It is not intended to be a full-featured Playdate SDK so please do not raise PRs to extend the Playdate Swift overlay to new areas.