Skip to content

Latest commit

 

History

History
108 lines (67 loc) · 4.07 KB

Readme-jp.md

File metadata and controls

108 lines (67 loc) · 4.07 KB

Kicooya Face SDK (ベータ版)

English

Kicooya Face SDK には、UserFace（ユーザー定義の Kicooya の再生画面)を作成するためのツール、およびドキュメントが含まれています。

  • Kicooya Face SDK は現在ベータリリースです。今後、大幅な仕様変更等が発生する可能性があることをご了承ください。
  • Data Folder にある Lua Script は実行できないため、Kicooya.pdx の中に UserFace の全ファイルをコピーして実行できるようにしています。そのため、Kicooya をアップデートしたときに、UserFace が削除されてしまう問題があります。今後の Face SDK 更新で、Lua Script のみを Kicooya.pdx にコピーするよう動作を変更する予定です。

ファイル構成

+- .kicooya         # ビルド、実行用 Shell ファイル
|   |
|   +- Kicooya.pdx  # シミュレータ用バイナリ
|
+- .nova            # Nova 関連ファイル
|
+- .vscode          # Visual Studio Code 関連ファイル
|
+- docs             # ドキュメント
|
+- Source           # サンプルソース

利用方法

1. 環境変数の設定

Kicooya Face SDK で参照する環境変数を設定します。

  • PLAYDATE_SDK_PATH

    Playdate SDK の PATH を指定してください。Playdate SDK で参照されているものと同じ変数名です。

2. UserFace を作成する

Nova または Visual Studio Code を利用して UserFaceを作成できます。(Windos / Mac のみ、Linux は未対応)

  • シミュレータでは Kicooya の Face Option 画面のみ確認できます。
  • Playdate 実機で動作を確認するには Kicooya をインストールしておく必要があります。

Nova

Nova で KicooyaFaceSDK フォルダを開いてください。

  1. ビルド

    CTRL + B または ツールバーのビルドボタン

  2. 実行

    CTRL + R または ツールバーの実行ボタン

    タスクの設定にあわせて、実行するターゲットが切り替わります。

    タスク名 ターゲット
    Kicooya Face Device 実機
    Kicooya Face Simulator シミュレータ

    Lua のブレークポイント (Playdate Lua debugging support) は利用できません。

Visual Studio Code

Visual Studio Code で KicooyaFaceSDK フォルダを開いてください。

Windows 環境では Visual Studio Code から bash を利用できるように設定しておく必要があります。

開発環境では Git Bash で動作確認しています。

  1. ビルド

    コマンドパレット(Ctrl+Shift+P) -> Tasks: Run Task -> Kicooya Face Build

  2. シミュレータで実行

    コマンドパレット(Ctrl+Shift+P) -> Tasks: Run Task -> Kicooya Face Build & Run Simulator

  3. 実機で実行

    コマンドパレット(Ctrl+Shift+P) -> Tasks: Run Task -> Kicooya Face Build & Run Device

ドキュメント

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

サンプル

リンク 種類 概要
Ctrl json コントロールのサンプル。
Lua Audio FQ json, lua Audio Spectrum を Lua で描画。
MaruMonica json, lua 組み込み以外のフォントを使用。(フォント: マルモニカ)
Text json テキストのサンプル。
zOrder json, lua zOrder のサンプル。

翻訳

作者が作成するドキュメントの元は日本語です。英語ドキュメントは機械翻訳を元にしているか、作成されていません。よろしければ、英語ドキュメントの作成、および間違いの指摘にご協力いただけると幸いです。