23 releases

0.2.3 Aug 24, 2024
0.2.2 Jul 13, 2024
0.2.1 May 30, 2024
0.1.16 Feb 11, 2024
0.0.0 Jun 9, 2021

#206 in Game dev

Download history 2/week @ 2024-06-15 1/week @ 2024-06-29 47/week @ 2024-07-06 116/week @ 2024-07-13 2/week @ 2024-07-20 5/week @ 2024-08-10 16/week @ 2024-08-17 164/week @ 2024-08-24 4/week @ 2024-08-31 2/week @ 2024-09-07 31/week @ 2024-09-14 37/week @ 2024-09-21 14/week @ 2024-09-28

84 downloads per month

MIT/Apache and maybe GPL-3.0+

5.5MB
120K SLoC

PlayDate API

Mostly high-level rusty API for the Playdate handheld gaming system.

Usage with cargo-playdate is strongly recommended.

What's inside

Covered parts of API:

Plus some extensions to make it all more rust-ish.

Not yet covered parts:

  • json

How to start

Look at the examples.

Examples

Here is available examples. You car run it with following command:

# Simulator:
cargo playdate run -p=playdate --example=hello-world --features=entry-point
# Device:
cargo playdate run -p=playdate --example=video --features=entry-point --device

More information how to use cargo-playdate in help: cargo playdate --help.

Prerequisites

Follow the instructions for:

  1. SDK
  2. cargo-playdate
  3. playdate-sys (prerequisites only)

Hello World

There is multiple ways to learn and start.

Following two is just a quick introduction. In details it all will be explained soon in the wiki.

Short Way

  1. Install cargo-playdate.
  2. cd where/your/project/will/be
  3. cargo playdate init --lib --full-metadata --deps="playdate" (more about it)
  4. cargo playdate run

Done. Now take a look at long way below for details what's happen.

Alternative Way

Just run cargo new <your options> and add do following:

  1. Add [playdate crate][playdate-crate] as dependency to your project
  2. #![no_std] for library, or #![no_std] #![no_main] for executable binary
  3. Look at existing example for api-parts like that
  4. Add minimally required metadata to build package:
  5. Install cargo-playdate to build your project
  6. Run cargo playdate run
  7. Help this project somehow.

Made with ❤️‍🔥 by me.

This software is not sponsored or supported by Panic.

Dependencies