46 releases
new 0.4.13 | May 12, 2024 |
---|---|
0.4.9 | Apr 30, 2024 |
0.3.16 | Mar 21, 2024 |
0.3.12 | Nov 21, 2023 |
0.0.0 |
|
#40 in Cargo plugins
1,574 downloads per month
510KB
12K
SLoC
Build System for Playdate applications
Cargo-playdate is a cross-platform plugin for cargo that can build programs for Playdate handheld gaming system written in Rust. It also works as standalone tool.
It can build programs written in Rust, manage assets, build package for Playdate and run on sim or device. Usually it builds static or dynamic libraries for sim and hardware, but also it can build executable binaries for hardware and this method produces highly optimized output with dramatically minimized size (thanks to DCE & LTO)*.
* For executable binaries use --no-gcc
argument.
Platform specific pre-req install instructions
MacOS:
- Install the PlaydateSDK (by default installs into
~/Developer/PlaydateSDK
) - Set PLAYDATE_SDK_PATH env var:
export PLAYDATE_SDK_PATH="$HOME/Developer/PlaydateSDK"
- Install cmake:
brew install cmake
- Install rust nightly:
rustup toolchain install nightly
- Arm toolchain is included with PlaydateSDK.
Ubuntu Linux:
- Install the PlaydateSDK - remember where you extracted it.
- Set PLAYDATE_SDK_PATH env var:
export PLAYDATE_SDK_PATH="/path/to/PlaydateSDK-2.x.x/"
- Install cmake:
sudo apt-get install cmake
- Install rust nightly:
rustup toolchain install nightly
- Install arm toolchain:
sudo apt-get install gcc-arm-none-eabi
- Install libudev:
sudo apt-get install libudev-dev
Windows:
- Install the PlaydateSDK (by default installs into
~/Documents/PlaydateSDK
) - Set PLAYDATE_SDK_PATH
- windows+r, run:
sysdm.cpl
- Advanced Tab -> Environment Variables -> New
- Variable name:
PLAYDATE_SDK_PATH
- Variable value:
C:\Users\username\Documents\PlaydateSDK
- windows+r, run:
- Install CMake: cmake downloads
- Install rust nightly:
rustup toolchain install nightly
- Install arm toolchain: arm gnu toolchain downloads. Filename will be like 'arm-gnu-toolchain-13.2.rel1-mingw-w64-i686-arm-none-eabi.exe'.
- Add arm toolchain and cmake to PATH environment:
- windows+r, run:
sysdm.cpl
- Advanced Tab -> Environment Variables.
- Find
Path
and clickEdit
- Click
New
and addC:\Program Files\CMake\bin
- Click
New
and addC:\Program Files (x86)\Arm GNU Toolchain arm-none-eabi\13.2 Rel1\bin
- windows+r, run:
See also: Inside Playdate with C: Prerequisites
Cargo-Playdate Installation
cargo +nightly install cargo-playdate
cargo +nightly playdate --version
Or install to use bleeding edge bits from a local git clone:
mkdir ~/code
cd ~/code
git clone https://github.com/boozook/playdate.git
cargo +nightly install --path="$HOME/code/playdate/cargo" cargo-playdate
Hello World
Generate new project using new
or init
command.
mkdir -p ~/code/pd-hello/
cd ~/code/pd-hello/
cargo +nightly playdate init --lib --full-metadata --deps="playdate"
cargo +nightly playdate run
Note, there are more options for this command, e.g.
--deps="sys:git, controls:git"
. Runcargo playdate new --help
for more about it.
New package will be created.
Take a look at the package manifest file (Cargo.toml).
There is extra metadata for your playdate package.
For more information about metadata read documentation.
Configuration
There is no configuration other then inherited by cargo and some special environment variables.
CARGO_PLAYDATE_LOG
working same way asCARGO_LOG
or defaultRUST_LOG
. AlsoCARGO_PLAYDATE_LOG_STYLE
PLAYDATE_SDK_PATH
path to the SDK rootARM_GCC_PATH
path to thearm-none-eabi-gcc
executable.
Execute cargo playdate -h
for more details, or with --help
for further more.
Limitations
- Global crate-level attributes like
crate_type
andcrate_name
doesn't supported, e.g:
#![crate_name = "Game"]
#![crate_type = "lib"]
- Cargo-targets such as
bin
andexample
should be in the cargo manifest. Autodetect isn't yet tested and may not work. Example:
[[example]]
name = "demo"
crate-type = ["dylib", "staticlib"]
path = "examples/demo.rs"
- Assets especially for
example
cargo-targets inherits from package assets. Currently there's no way to set assets for single cargo-target, but only for entire package or for dev-targets - there isdev-assets
extra table inherited by main.
Troubleshooting
-
On windows in some cases hardware cannot be ejected because of no permissions. Try to give rights and/or build
cargo-playdate
with featureeject
. -
Welcome to discussions and issues.
This software is not sponsored or supported by Panic.
Dependencies
~91–125MB
~2.5M SLoC