asuka.json

asuka.json はアプリのディレクトリに置くファイルで、プラットフォームとストアが知っておくべきアプリの情報を書きます。アプリの名前と ID、アイコン、アプリで開くリンクとファイル、署名の鍵などです。asuka dev、asuka build、asuka publish がこのファイルを読みます。asuka dev は起動時に読むので、変更したら一度止めて実行し直してください。

キーはすべて省略できます。このファイルがないアプリも、デフォルトの値でビルドして実行できます。Asuka が知らないキーは無視されるので、キーが効いていないように見えるときはつづりを確認してください。Asuka が受け付けられない値があると、ビルドは止まり、どのキーに何が求められているかを表示します（asuka.json: accent "red" (want #rrggbb or #rrggbbaa)）。パスはアプリのディレクトリからの相対パスです。

このページではすべてのキーを紹介します。リリースのためにキーをどう組み合わせるかは配布で、各キーの働きの詳細は、下にリンクしたそれぞれのガイドで説明しています。

{
  "name": "Notes",
  "id": "com.example.notes",
  "version": "1.2.0",
  "build": 7,
  "icon": "icon.png",
  "accent": "#7c3aed",
  "scheme": "notes",
  "links": ["notes.example.com"],
  "fileTypes": [{ "name": "Notes Document", "extensions": ["note"] }],
  "shareTarget": true,
  "splash": { "image": "logo.png", "background": "#ffffff", "darkBackground": "#000000" },
  "ios": {
    "team": "ABCDE12345",
    "usage": { "NSCameraUsageDescription": "To scan your receipts." }
  },
  "android": { "keystore": "upload.jks", "keyAlias": "upload", "dynamicColor": true },
  "linux": { "summary": "Write things down", "categories": ["Office"], "license": "MIT" },
  "updates": { "publicKey": "…", "github": "you/notes" }
}

アプリ

これらのキーは、そのキーに意味があるすべてのプラットフォームで使われます。

Windows のビルドに必要なのはこれだけです。署名の証明書は環境変数で渡します（配布を参照）。

fileTypes

アプリが開くファイルの種類です。ファイルマネージャー、メールの添付ファイル、「このアプリケーションで開く」から開かれたファイルは、ui.OnOpenFiles が受け取ります。それぞれの種類は次のようなオブジェクトです。

"fileTypes": [
  { "name": "Markdown Document", "extensions": ["md", "markdown"], "role": "viewer" },
  { "name": "Notes Document", "extensions": ["note"], "icon": "note.png" }
]

ファイルの種類の宣言方法はプラットフォームごとに異なります。Mac と iOS では Info.plist の CFBundleDocumentTypes、Android ではインテントフィルター、Windows ではアプリの起動時にユーザーのレジストリ、Linux ではデスクトップファイルと shared-mime-info のパッケージ、Web ではマニフェストの file_handlers で宣言します。配布とファイルを開くを参照してください。

shareTarget

iOS と Android で、ほかのアプリの共有シートにアプリを表示します。共有されたものは ui.OnShare が受け取ります。true にするとテキストと Web のリンクを受け取ります。ほかのものも受け取るときはオブジェクトで指定します。

"shareTarget": { "types": ["text", "image/*", "video/*"], "max": 10 }

iOS では、アプリの中の共有拡張機能（share extension）になります。独自の bundle ID（アプリの ID に .share を付けたもの）を持ち、リリースでは ios.shareProfile で署名します。ファイルを受け取る場合は、App Group group.<id> も必要です。配布とほかのアプリからの共有を参照してください。

splash

iOS と Android の起動画面です。アイコンをタップしてからアプリの最初のフレームが出るまで（または splash.Hide を呼ぶまで）、単色の背景の中央に画像を表示します。デスクトップと Web には起動画面がありません。

"splash": { "image": "logo.png", "size": 96, "background": "#4A63B5", "darkBackground": "#1B2440" }

起動画面を参照してください。

widgets

iOS と Android でのアプリのホーム画面ウィジェットです。中身はアプリの Go のコードから widget.Set で埋めます。

"widgets": [{ "kind": "today", "name": "Today", "description": "What's next", "sizes": ["small", "medium", "rectangular"] }]

iOS では、ウィジェットは独自の bundle ID（アプリの ID に .widgets を付けたもの）を持つ拡張機能になり、リリースでは ios.widgetProfile で署名します。ホーム画面ウィジェットを参照してください。

shortcuts

システムがアプリのために表示するアクションで、最大 10 個です。iOS の App Shortcuts（Siri、Spotlight、ショートカットアプリ、アクションボタン）と、Android のランチャーのショートカットになります。どれも、ui.OnOpenURL に渡される URL でアプリを開きます。

"shortcuts": [{ "id": "newNote", "title": "New Note", "url": "notes://new", "symbol": "square.and.pencil", "phrases": ["New note in ${app}"] }]

ショートカットを参照してください。

i18n

アプリのメッセージカタログの場所です。カタログが locales ディレクトリにあるアプリには不要です。

"i18n": { "dir": "translations", "source": "ja" }

多言語対応を参照してください。

updates

デスクトップアプリのアップデートの設定で、アップデートに署名する鍵と、アップデートを公開する場所を指定します。asuka update keygen が鍵ペアを作り、このオブジェクトを出力します。

"updates": { "publicKey": "…the contents of asuka-update.pub…", "github": "you/notes" }

github と url のどちらか一方が必要で、両方は指定できません。アップデートを参照してください。

ios

iOS のビルドの設定です。team は Mac のビルドのチームにもなり、usage の利用目的の文字列は Mac の Info.plist にも入ります。

collected の各要素はデータの種類で、Apple の名前から接頭辞を除いたもので指定します。これは Asuka が書き出すプライバシーマニフェストに使われます（アプリ独自の ios/PrivacyInfo.xcprivacy があれば、Asuka のマニフェストとこの設定はそれに置き換わります）。

"collected": [{ "type": "EmailAddress", "linked": true, "tracking": false, "purposes": ["AppFunctionality"] }]

配布を参照してください。

mac

Mac のビルドがアプリの署名に使うものです。チームは ios.team です。

--profile と ASUKA_MAC_PROFILE で上書きできます。配布を参照してください。

android

Android のビルドの設定です。

配布を参照してください。

linux

Linux のビルドが、デスクトップファイルと AppStream の metainfo に書き出すアプリの情報です。ランチャー、ソフトウェアセンター、Flathub に表示されます。Flathub とソフトウェアセンターは、概要、説明、ライセンス、開発者を求めます。

配布を参照してください。

web

Web のビルドの設定です。

Web Push を参照してください。

環境変数

秘密の情報は asuka.json に書かず、環境変数で渡してください。CI では CI のシークレットから渡します。これらの環境変数は、対応するキーを上書きもします。