NarraLeaf Desktop
NarraLeaf Desktop のランタイム、renderer、プロジェクト設定、CLI に関するデスクトップ版ビジュアルノベルアプリのドキュメント
NarraLeaf Desktop のドキュメントへようこそ。
NarraLeaf Desktop は、Electron、React、NarraLeaf-React の上に構築されたデスクトップ版ビジュアルノベルアプリのツールチェーンです。主プロセスのランタイム、renderer のシェル、セーブブリッジ、ページルーティング、プロジェクト設定、そして完全なパッケージアプリを作成するための CLI ワークフローを提供します。
NarraLeaf Desktop を選ぶ理由
- 完全なデスクトップアプリ：既存の Web ページにプレイヤーを埋め込むだけでなく、独立した Electron アプリケーションを構築できます。
- 型付けされたランタイム：主プロセス、renderer ブリッジ、セーブシステム、ビルドターゲットを TypeScript フレンドリーな API で設定できます。
- 内蔵の NarraLeaf-React：NarraLeaf-React でストーリーを作成し、アプリの起動、ルーティング、永続化、パッケージ化は NarraLeaf Desktop に任せられます。
React のプレイヤーフレームワークだけが必要な場合は NarraLeaf-React を選んでください。デスクトップアプリのシェル、CLI、配布ワークフローも必要な場合は NarraLeaf Desktop を選んでください。
はじめに
まずインストールを行い、そのあとプロジェクトを作成してローカルで実行します。
Installation
NarraLeaf Desktop アプリが使う CLI とランタイムパッケージをインストールする
Quick Start
最初の NarraLeaf Desktop プロジェクトを作成し、開発サーバーを起動する
モジュール
Main
Electron の主プロセスランタイム、AppConfig、App、AppWindow、hooks、ストレージ
Renderer
renderer のエントリ、App プロバイダ、セーブ用 hooks、型付けされた主プロセスイベント、ページルーティング
CLI
init、dev、build、info 用のプロジェクトコマンドと、生成される renderer のエントリ
プロジェクトのセットアップ
Project Config
narraleaf.config.js と必須のプロジェクトフォルダについて理解する
Build Targets
narraleaf/config を通じて Windows、macOS、Linux のターゲットを設定する
推奨する読み進め方
- Installation を読みます。
- Quick Start を進めます。
- Project Config を学びます。
- API の詳細が必要になったら Main と Renderer を参照します。
- ローカル開発とパッケージ化を自動化する準備ができたら CLI を使います。
Note: NarraLeaf Desktop は初期開発段階にあります。文書化するに足るほど安定した API もありますが、プロジェクトでは NarraLeaf Desktop、NarraLeaf-React、Electron、React のバージョンを揃えておいてください。