NarraLeaf DesktopRenderer
Renderer
renderer のランタイム、アプリ hooks、セーブ用 API、主プロセスイベント、ファイルベースのページルーティング
Renderer モジュールは、NarraLeaf デスクトップアプリの React 側です。生成されたアプリのエントリをマウントし、アプリケーションシェルを提供し、NarraLeaf-React の Player を埋め込み、セーブ、再生状態、renderer から main への通信のための hooks を公開します。
import {
render,
useApp,
useGamePlayback,
useSaveAction,
invokeMainEvent,
} from "narraleaf/renderer";ガイド
Render
生成される renderer のエントリと render() 起動関数を理解する
App State
RendererApp のシェルと再生状態にアクセスする
Save System
セーブ用 hooks、現在のスナップショット、クイックセーブ、セーブのメタデータを使う
Main Events
renderer から文字列キーまたは型付けされた主プロセスハンドラを呼び出す
Page Router
CLI がスキャンするファイルベースのページ規則を学ぶ
公開エクスポート
renderuseAppuseAppStateuseGamePlaybackuseCurrentSaveduseCurrentSavedRefuseSaveActionuseSavedGamesreadGamerequestMaininvokeMainEventSaveType
renderer のエントリは、RendererApp、RendererAppRootProps、GameMetadata、ルートモジュールの型、セーブ結果の型、MainProcessEventMap、MainProcessEventEntry といった公開の型もエクスポートします。
NarraLeaf-React との関係
NarraLeaf は、ストーリーの再生に NarraLeaf-React を使用します。ストーリー、シーン、キャラクター、メニュー、displayable は NarraLeaf-React で作成し、そのストーリーを NarraLeaf の renderer アプリの metadata.story を通じてエクスポートします。