NarraLeaf Desktop

欢迎来到 NarraLeaf Desktop 的文档！

NarraLeaf Desktop 是基于 Electron、React 与 NarraLeaf-React 的桌面视觉小说应用工具链。它提供主进程运行时、渲染器壳层、存档桥接、页面路由、项目配置和 CLI 工作流，用于创建完整的可打包桌面应用

为什么使用 NarraLeaf Desktop?

• 完整桌面应用：构建独立 Electron 应用，而不只是把播放器嵌入已有网页
• 类型化运行时能力：用对 TypeScript 友好的 API 配置主进程、渲染桥、存档系统和构建目标
• 内置 NarraLeaf-React：使用 NarraLeaf-React 创作故事，再由 NarraLeaf Desktop 负责应用启动、路由、持久化和打包

如果你只需要 React 播放器框架，请选择 NarraLeaf-React。如果你还需要桌面应用壳、CLI 与交付流程，请选择 NarraLeaf Desktop

立即开始

先安装依赖，然后创建项目并在本地运行

模块

项目设置

推荐阅读顺序

1. 阅读 安装
2. 完成 快速开始
3. 学习 项目配置
4. 需要 API 细节时阅读 Main 与 Renderer
5. 准备自动化本地开发和打包时阅读 CLI

注意： NarraLeaf Desktop 仍处于早期开发阶段。本文档记录的是当前代码中可验证的 API，但项目中仍建议保持 NarraLeaf Desktop、NarraLeaf-React、Electron 与 React 版本一致