Playdate SDK setup for Neovim
A local copy of the Playdate SDK.
Optional: a local copy of playdate-luacats
lazy.nvim:
{
"sqwxl/playdate.nvim",
opts = {
playdate_sdk_path = "/path/to/playdate-sdk", -- or set PLAYDATE_SDK_PATH
playdate_luacats_path = "/path/to/playdate-luacats" -- or set PLAYDATE_LUACATS_PATH (optional)
build = {
source_dir = "src",
output_dir = "build.pdx"
}
server_settings = {
-- Server settings placed here will be merged into the defaults shown below.
}
}
}:PlaydateSetup- Set up Neovim and LuaLS for a Playdate project:PlaydateBuild [src [out]]- Compile a project withpdc:PlaydateBuildRun [src [out]]- Compile and run a project in the Playdate simulator:PlaydateRun [out]- Run a compiled project in the Playdate simulator
When loaded, the plugin looks for a pdxinfo file in build.source_dir in the current working directory to determine if it is a Playdate project. If so, it will overwrite the lua_ls configuration with the following (including any custom settings provided in server_settings). You can also trigger this manually with :PlaydateSetup.
{
Lua = {
completion = {
requireSeparator = "/",
},
diagnostics = {
disable = { "lowercase-global" },
severity = {
["duplicate-set-field"] = "Hint",
},
},
runtime = {
builtin = {
io = "disable",
os = "disable",
package = "disable",
},
nonstandardSymbol = {
"+=",
"-=",
"*=",
"/=",
"//=",
"%=",
"<<=",
">>=",
"&=",
"|=",
"^=",
},
special = { import = "require" },
},
workspace = {
library = {
options.playdate_sdk_path,
options.playdate_luacats_path,
},
},
},
}You may need to disable the crash report prompt in your Playdate Simulator settings (Settings > General > Privacy > Send Crash Reports).