https://github.com/bedinotti/playlate

A template for Playdate games
https://github.com/bedinotti/playlate

c lua playdate

Last synced: 3 months ago
JSON representation

A template for Playdate games

• Host: GitHub
• URL: https://github.com/bedinotti/playlate
• Owner: bedinotti
• License: mit
• Created: 2022-03-07T04:35:10.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-22T02:29:11.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T23:31:01.059Z (6 months ago)
• Topics: c, lua, playdate
• Language: Lua
• Homepage:
• Size: 34.2 KB
• Stars: 64
• Watchers: 2
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-playdate - Playlate

README

        
# Playlate

[Playdate](https://play.date) + template = Playlate

Use this template to explore the [Playdate SDK](https://play.date/dev/) 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](https://docs.github.com/en/repositories/creating-and-managing-repositories/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](https://play.date/dev/) and adds a few nifty features.

### Standardized Structure

This template uses the [recommended folder structure](https://sdk.play.date/1.9.3/Inside%20Playdate.html#_structuring_your_project)

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](https://nova.app), 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](nova://extension/?id=pro.albright.luacheck&name=Luacheck).

### VSCode Features

Prefer to use [Visual Studio Code](https://code.visualstudio.com)? 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](https://marketplace.visualstudio.com/items?itemName=sumneko.lua).

### GitHub `luacheck` Action

This also ships with a GitHub Action that runs [the `luacheck` code linter](https://github.com/lunarmodules/luacheck)

on your code before merging to the `main` branch.

## License

This is licensed under the MIT License. See [LICENSE.md](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](https://play.date/dev/sdk-license) when building

your games.