Kicooya Face SDK （Beta release)

日本語

The Kicooya Face SDK includes tools and documentation for creating UserFaces (user-defined Kicooya playback screens).

• Kicooya Face SDK is currently in Beta release. Please note that there is a possibility of significant specification changes in the future.
• User face files are copied into Kicooya.pdx, because Lua Scripts in the Data Folder cannot be executed. Therefore, there is a problem that UserFace is deleted when Kicooya is updated. In a future Face SDK update, it is planned to change the behavior so that only the Lua Script is copied to Kicooya.pdx.

Folder structure

+- .kicooya         # Shell files for build and run
|   |
|   +- Kicooya.pdx  # Binary for Simulator
|
+- .nova            # Files for Nova
|
+- .vscode          # Files for Visual Studio Code
|
+- docs             # Documents
|
+- Source           # Sample sources

Usage

1. Setting environment variables

Set environment variables for Kicooya Face SDK.

• PLAYDATE_SDK_PATH

  Specify the PATH of the Playdate SDK, with the same variable names as in the Playdate SDK.

2. Create a UserFace

Nova or Visual Studio Code can be used to create UserFace.

• In the simulator, only Kicooya's Screen of 'Face Option' is available.
• In the Playdate Device, Kicooya must be installed in order to Check if UserFace works.

Nova

Open the KicooyaFaceSDK folder in Nova.

1. Build

   CTRL + B or Build button on toolbar

2. Run

   CTRL + R or Run button on toolbar

   The target to be executed switches according to the task settings.

   Task name	Target
   Kicooya Face Device	Device
   Kicooya Face Simulator	Simulator

   Playdate Lua debugging is not supported.

Visual Studio Code

Open the KicooyaFaceSDK folder in Visual Studio Code.

In a Windows environment, bash must be configured to be available from Visual Studio Code.

In the development environment, we have confirmed that it works with Git Bash.

1. Build

   Command Palette (Ctrl+Shift+P) -> Tasks: Run Task -> Kicooya Face Build

2. Run Simulator

   Command Palette (Ctrl+Shift+P) -> Tasks: Run Task -> Kicooya Face Build & Run Simulator

3. Run Device

   Command Palette (Ctrl+Shift+P) -> Tasks: Run Task -> Kicooya Face Build & Run Device

Documents

1. face.json Document
2. Kicooya UserFace API Document

Samples

Link	Type	Description
Ctrl	json	Sample of control.
Lua Audio FQ	json, lua	Audio Spectrum is drawn in Lua.
MaruMonica	json, lua	Use a font that is not built-in. (Font: MaruMonica)
Text	json	Sample of text.
zOrder	json, lua	Sample of zOrder.

Translation

The original documentation created by the author is in Japanese. English documentation is either based on machine translation or has not been created. If you would like to help us, we would appreciate it if you could create English documentation and point out any errors.