https://github.com/midouest/vscode-playdate-debug
Unofficial Playdate debug extension for Visual Studio Code on macOS, Windows and Ubuntu
https://github.com/midouest/vscode-playdate-debug
debugger playdate playdate-console vscode vscode-extension
Last synced: 2 months ago
JSON representation
Unofficial Playdate debug extension for Visual Studio Code on macOS, Windows and Ubuntu
- Host: GitHub
- URL: https://github.com/midouest/vscode-playdate-debug
- Owner: midouest
- License: mit
- Created: 2022-03-16T04:54:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-11-21T04:58:38.000Z (6 months ago)
- Last Synced: 2026-03-12T21:15:51.235Z (3 months ago)
- Topics: debugger, playdate, playdate-console, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=midouest.playdate-debug
- Size: 1.6 MB
- Stars: 50
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Playdate Debug
[](https://github.com/midouest/vscode-playdate-debug/actions/workflows/tests.yaml)
Unofficial Playdate debug extension for Visual Studio Code on macOS, Windows and Ubuntu
## Features
- Debug Lua code running in the Playdate Simulator
- Compile games to `.pdx` using `pdc`
- Problem matchers for `pdc`
- Open the Playdate Simulator
- Run and debug current Lua file in the Playdate Simulator from the editor toolbar
## Requirements
- The [Playdate SDK](https://play.date/dev/) must be installed separately
## Quick setup
### Tasks and debug launcher
Copy the following `.vscode/tasks.json` and `.vscode/launch.json` configuration:
```json
// .vscode/tasks.json
{
"version": "2.0.0",
"tasks": [
{
"type": "pdc",
"problemMatcher": ["$pdc-lua", "$pdc-external"],
"label": "Playdate: Build"
},
{
"type": "playdate-simulator",
"problemMatcher": ["$pdc-external"],
"label": "Playdate: Run"
},
{
"label": "Playdate: Build and Run",
"dependsOn": ["Playdate: Build", "Playdate: Run"],
"dependsOrder": "sequence",
"problemMatcher": [],
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
```
```json
// .vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"type": "playdate",
"request": "launch",
"name": "Playdate: Debug",
"preLaunchTask": "${defaultBuildTask}"
}
]
}
```
The debugger can be launched from the "Run and Debug view" by selecting the "Playdate: Debug" launch configuration and then clicking the "Start Debugging" button.
A [cookiecutter project template](https://github.com/midouest/cookiecutter-playdate) is available for quickly generating new projects with the above configuration from the command line.
See the [basic configuration example](/fixtures/workspace/basic-configuration) for more information.
### Run and debug current Lua file
**NOTE:** The "Run/Debug file in Playdate Simulator" command is intended to be a shortcut for prototyping and learning. It is recommended to use the [task and launch configuration above](#tasks-and-debug-launcher).
The extension can build, run and debug the current Lua file in the editor with zero configuration as long the [automatic configuration conditions](#automatic) are met.
When you open a Lua file in the editor after installing the extension, you will now see a
launch icon and dropdown menu in the editor toolbar. Clicking the launch icon or selecting an item from the dropdown menu will build and run the current Lua file in the Playdate Simulator. The "Debug file in Playdate Simulator" option will enable breakpoints to be hit.
## Configuration
### Automatic
The tasks and debugger will attempt to automatically resolve the correct configuration using the environment. One of the following conditions must be met for this to work:
- The `PLAYDATE_SDK_PATH` environment variable is set to the Playdate SDK path
- `~/.Playdate/config` exists and the `SDKRoot` property is set to the Playdate SDK path (macOS only)
### Workspace settings override
The default behavior can be overridden by setting the SDK path, game source path, compiled game path or game name in your workspace's `settings.json` file. The extension will fall back to the default behavior for any configuration fields that are not set.
```json
// .vscode/settings.json
{
"playdate-debug.sdkPath": "/path/to/PlaydateSDK",
"playdate-debug.sourcePath": "/path/to/MyGame/source",
"playdate-debug.outputPath": "/path/to/MyGame",
"playdate-debug.productName": "My Game"
}
```
See the [override configuration example](/fixtures/workspace/override-configuration) for more information about these properties.
### PDC task
See the [pdc configuration example](/fixtures/workspace/pdc-configuration/) for additional `pdc` task properties.
### Playdate Simulator task
See the [playdate simulator configuration example](/fixtures/workspace/playdate-simulator-configuration/) for additional `playdate-simulator` task properties.
### Debugger
See the [debugger configuration example](/fixtures/workspace/debugger-configuration/) for additional `playdate` debugger properties.