building-from-source.md

Building Playboy from source

Please note: If you just want to play Gameboy games on your Playdate, you don't need to do this!

These steps are for folks who want to work directly on the code for Playboy itself.

Playdate isn't exactly a Tier 1 platform for Rust :)

As a result, the build is a little bit trickier than usual, but you can install Playboy by following these steps.

Prerequisites

You'll need

• The Playdate SDK
• Rustup
• Nightly Rust (runrustup default nightly)
• Crank, the actual tool for compiling Rust for Playdate

Running

git clone https://github.com/adamsoutar/playboy
cd playboy
git submodule init
git submodule update

Now we can finally build & run the code:

crank run --release

This will launch the Playdate Simulator and boot right in to your favourite Gameboy game!