EdAyers / UPWARD-for-Playdate

Port of Matthias Falk's Upward to Playdate

UPWARD for Playdate

Overview

This repository contains the full source code and assets for the port of Matthias Falk's PICO-8 game, UPWARD, to Playdate.

Both this Playdate verion and the original PICO-8 version of UPWARD are available to play for free!

The code is released under GPLv3, but if you wish to write your own proprietary Playdate game in Zig, feel free to use my Zig-Playdate template, which is released to the public domain.

Compilation Requirements

• Either macOS, Windows, or Linux.
• Zig compiler 0.11.0-dev.3867+ff37ccd29 or newer. Pulling down the latest build is your best bet.
• Playdate SDK installed.

Compiling

1. Make sure the Playdate SDK is installed, Zig is installed and in your PATH, and all other requirements are met.
2. Run zig build -Doptimize=ReleaseFast which will compile the release version of the game.
   • If there any errors, double check PLAYDATE_SDK_PATH is correctly set and either binutils or the ARM Toolchain (depending on your OS) is properly installed and set in your PATH.
3. The upward.pdx executable should be produced in the newly created zig-out folder.
   • Keep in mind, this executable will only run on the platform you compiled on, plus Playdate hardware. If you want your updward.pdx to be "universal", you will need to compile this codebase on macOS, Windows, and Linux, and have an upward.pdx that contains pdex.dylib, pdex.dll, and pdex.so.

Running on the Playdate Simulator

1. Make sure the Playdate Simulator is closed.
2. Run zig build -Doptimize=ReleaseFast run.
   • If there any errors, double check PLAYDATE_SDK_PATH is correctly set and either binutils or the ARM Toolchain (depending on your OS) is properly installed and set in your PATH.
3. Optionally, connect your Playdate to the comupter and upload to the device by going to Device -> Upload Game to Device.. in the Playdate Simulator.

Profiler

While working on this project, I wrote a performance profiler to help me keep track of how fast each frame was and performance of certain complex code.

It is disabled in the final release, but, if you're curious to take a look at these metrics, you can renable the profiler by setting ENABLE_PROFILING to true in profiler.zig. Then, while running the game, you can toggle the profiler buy holding the A, B, and Up buttons.

Credits

• Daniel Bokser - Ported UPWARD to Playdate.
• Matthias Falk - Creator of the original UPWARD game on PICO-8 and contributed some UX ideas to the port.