Playlate

Playdate + template = Playlate

Use this template to explore the Playdate SDK and get to building your game faster.

How to Use

Use this project to get started, then add your code and/or remove the bits you don't need. You can either use this template:

• directly on GitHub, or
• by downloading the zip file for this repo.

On GitHub

This repo is a GitHub Template. Click "Use this template" in the top right to create your own repository based off of the code here. See Creating a Repository from a Template for more information.

From ZIP File

You can also download a zip of this repository and start there. Head on over to [the Releases] area of this repo and download the latest version. Or, if you're feeling brave, download the latest by clicking Code > Download ZIP.

Features

This builds off of the "Game Template" project provided in the Playdate SDK and adds a few nifty features.

Standardized Structure

This template uses the recommended folder structure for Playdate games. Empty folders are preserved with an empty .gitkeep file that can be deleted if you'd like.

Default Callbacks

The Playdate SDK calls a few callbacks based on user interaction, the state of the device, and other game lifecycle events. Each of these have been implemented with a default implementation that prints out that each method has been called.

Nova Features

For folks who use Nova, you've got a few extra goodies:

• A Playdate Simulator Task, to easily build & run your game.
• A .luacheckrc file for linting your lua code with the Luacheck Extension.

VSCode Features

Prefer to use Visual Studio Code? You get some goodies too:

• Added Compile, Run, Build and Clean tasks, with a default Build task.
• Updated settings to work with the lua-language-server extension.

GitHub luacheck Action

This also ships with a GitHub Action that runs the luacheck code linter on your code before merging to the main branch.

License

This is licensed under the MIT License. See LICENSE.md for more details. Generally: anything you build with this is yours.

This template only works with the Playdate SDK. Make sure you follow the terms of the Playdate SDK License when building your games.