pdShared

A small library to make working with the Shared folder in playdate easier

Quick Start

import "pdShared"

-- Creates /Shared/Data/com.example.mygame/ (if it doesn't exist)
local shared = playdate.file.shared("Data")
print("Shared path: " .. shared:getPath())

-- Create a json file at /Shared/Data/com.example.mygame/test.json
shared.datastore.write({foo="bar"}, "test")
-- Print out the file
printTable(shared:listFiles("."))

Functions

Most of the functions match the playdate file/datastore API but operate relative to the Shared folder.

`playdate.file.shared.getBundleId([id])`

Returns the sanitized bundle id of the game, which removes any user.1234. prefix in the case of sideloaded games. If id is not provided playdate.metadata.bundleID is used.

`playdate.file.shared.gameExists(id, [prefix])`

Checks if a game's data is present in the Shared folder. The prefix is optional and defaults to nothing.

local shared <const> = playdate.file.shared

-- Checks for the existence of /Shared/com.example.mygame
if shared.gameExists("com.example.mygame") then
    print("Game data exists")
end
-- Checks for the existence of /Shared/Achievements/com.example.mygame
if shared.gameExists("com.example.mygame", "Achievements") then
    print("Game data exists")
end

`playdate.file.shared([id], [prefix])`

id (string) - The optional id of the game. Defaults to a sanitized bundle id of the game.
prefix (string) - The optional path to the Shared folder. Defaults to nothing and places your game's folder in the root of /Shared.

`playdate.file.shared:getPath()`

Returns the path to the Shared folder.

`playdate.file.shared`

The following functions match their signatures from the SDK, but operate on files in the Shared folder:

shared:open(path, [mode])
shared:listFiles(path, [showhidden])
shared:exists(path)
shared:isdir(path)
shared:mkdir(path)
shared:delete(path, [recursive])
shared:getSize(path)
shared:getType(path)
shared:modTime(path)
shared:rename(path, newPath)

`playdate.file.shared.datastore`

All functions match the signatures from the SDK, but operate on files in the Shared folder:

shared.datastore.write(table, [filename], [pretty_print])
shared.datastore.read([filename])
shared.datastore.delete([filename])
shared.datastore.writeImage(image, path)
shared.datastore.readImage(path)

GammaGames / pdShared