Added convenience make targets and refined documentation in the HelloPlayDate example target.

This commit is contained in:
2026-07-25 11:33:09 +02:00
parent 988f900c23
commit f04a5ea7df
3 changed files with 48 additions and 21 deletions
+20 -1
View File
@@ -28,4 +28,23 @@ OBJS += build/Modules/playdate_device.o
build/game_simulator.o: Sources/HelloPlaydate/*.swift build/Modules/playdate_simulator.o
$(SWIFT_EXEC) $(SWIFT_FLAGS) $(SWIFT_FLAGS_SIMULATOR) -c $(filter %.swift,$^) -o $@
$(OBJDIR)/pdex.${DYLIB_EXT}: build/game_simulator.o
SIMCOMPILER += build/game_simulator.o
SIMCOMPILER += build/game_simulator.o
# MARK: - Convenience Targets
# The SDK's common.mk (included via swift.mk) already provides the build
# targets, all packaging $(PRODUCT) with pdc:
# make device binary + simulator dylib (alias: all)
# make simulator simulator dylib only
# make device device binary only
.PHONY: run clean-swiftpm
# Build the simulator flavor and launch the pdx in the Playdate Simulator.
run: simulator
open -a "$(SDK)/bin/Playdate Simulator.app" $(PRODUCT)
# common.mk's clean removes the build folder, $(PRODUCT), and the binaries
# copied into Source/; also drop the .build folder SwiftPM leaves behind
# when building with build.sh.
clean: clean-swiftpm
clean-swiftpm:
-rm -rf .build
+11 -2
View File
@@ -6,7 +6,11 @@ let package = Package(
name: "HelloPlaydate",
products: [
// The Playdate Simulator loads the game as pdex.dylib.
.library(name: "pdex", type: .dynamic, targets: ["HelloPlaydate"]),
.library(
name: "pdex",
type: .dynamic,
targets: ["HelloPlaydate"]
),
],
dependencies: [
.package(path: "../.."),
@@ -14,7 +18,12 @@ let package = Package(
targets: [
.target(
name: "HelloPlaydate",
dependencies: [.product(name: "PlayDate", package: "play-date")]
dependencies: [
.product(
name: "PlayDate",
package: "play-date"
)
]
),
]
)
+17 -18
View File
@@ -1,38 +1,37 @@
# Hello Playdate
A minimal game built on the `play-date` bindings: a bouncing box, a
crank-aimed needle, button handling, a system menu item, and an FPS counter.
A minimal game built on the `play-date` bindings: a bouncing box, a crank-aimed needle, button handling, a system menu item, and an FPS counter.
## Build and run (Playdate Simulator)
With the Playdate SDK installed (and the one-time
`Scripts/install-pkgconfig.sh` setup from the repository root done):
With the Playdate SDK installed (and the one-time` Scripts/install-pkgconfig.sh` setup from the repository root done):
```sh
./build.sh
open -a "$HOME/Developer/PlaydateSDK/bin/Playdate Simulator.app" HelloPlaydate.pdx
```
The script compiles the game as a dylib, places it in `Source/` next to
`pdxinfo`, and runs the SDK's `pdc` to produce `HelloPlaydate.pdx`.
The script compiles the game as a dylib, places it in `Source/` next to` pdxinfo`, and runs the SDK's `pdc` to produce `HelloPlaydate.pdx`.
## Device builds
The Makefile cross-compiles the game with Embedded Swift and packages a
`HelloPlaydate.pdx` containing both the device binary and the simulator
dylib. It needs:
The Makefile cross-compiles the game with Embedded Swift and packages a` HelloPlaydate.pdx` containing both the device binary and the simulator dylib. It needs:
- the Playdate SDK (`PLAYDATE_SDK_PATH`, or the path in `~/.Playdate/config`),
- the Arm GNU toolchain (`arm-none-eabi-gcc`) on `PATH`,
- a swift.org development-snapshot toolchain (Xcode's toolchain does not
ship the Embedded Swift stdlib for the device target). A toolchain
installed at `~/Library/Developer/Toolchains` is picked up automatically;
otherwise pass `TOOLCHAINS=<bundle id>`.
- a swift.org development-snapshot toolchain (Xcode's toolchain does not ship the Embedded Swift stdlib for the device target). A toolchain installed at `~/Library/Developer/Toolchains` is picked up automatically; otherwise pass `TOOLCHAINS=<bundle id>`.
```sh
make
```
Swift code is compiled with `-Osize` by default; use `make SWIFT_OPT=-O` to
favor speed over size. Sideload the pdx from the Playdate Simulator
(Device > Upload Game to Device) or with the SDK's `pdutil`.
Swift code is compiled with `-Osize` by default; use `make SWIFT_OPT=-O` to favor speed over size. Sideload the pdx from the Playdate Simulator (Device > Upload Game to Device) or with the SDK's `pdutil`.
## Make targets
All build targets package `HelloPlaydate.pdx` with the SDK's `pdc`. Note that every target — the simulator-only ones included — needs the device toolchain setup above, because the shared make rules resolve it up front;` build.sh` is the simulator flow without that requirement.
| Target | Effect |
|---|---|
| `make` | Build the device binary and the simulator dylib (alias: `make all`) |
| `make simulator` | Build the simulator dylib only |
| `make device` | Build the device binary only |
| `make run` | Build the simulator flavor and open the pdx in the Playdate Simulator |
| `make clean` | Remove the `build/` and `.build/` folders, the pdx, and the binaries copied into `Source/` |