Skip to content

安装与创建项目 ​

本章带你从零搭建开发环境,创建第一个灵泛引擎项目并运行起来。

环境要求 ​

依赖版本说明
.NET SDK10.0+下载地址
灵泛引擎 SDK最新随引擎仓库分发

验证 .NET 安装

打开终端,运行 dotnet --version,应输出 10.0.x 或更高版本。

创建项目 ​

方式一:使用 SDK(推荐) ​

启动灵泛引擎 SDK(LingFanEngine.SDK.Desktop),点击「新建项目」:

  1. 填写项目名称(如 MyNovel)
  2. 选择模板(V1)
  3. 选择目标平台(Windows / Linux / macOS / Android / iOS / Browser)
  4. 点击创建

SDK 会自动生成完整的项目结构。

方式二:从模板手动创建 ​

如果不用 SDK,可以直接复制 Template/V1 目录并修改项目名。

项目结构 ​

创建后的项目结构如下:

MyNovel/
├── MyNovel/                      # 核心项目(引用引擎)
│   ├── MyNovel.csproj
│   ├── Program.cs                # 入口
│   ├── Views/
│   │   └── MainView.cs           # 主窗口
│   ├── Extensions/
│   │   └── ServiceExtensions.cs  # DI 注册
│   └── DLL/                      # 引擎 DLL
├── MyNovel.Windows/              # Windows 平台项目
│   └── MyNovel.Windows.csproj
├── Stories/                      # ← 你的剧本放这里
│   └── title/
│       └── title_main.story      # 入口剧本
├── Media/                        # ← 媒体资源
│   ├── Images/
│   ├── Audio/
│   └── Video/
└── MyNovel.lfproj               # SDK 项目文件

关键目录

  • Stories/——你的 .story 剧本文件
  • Media/——图片、音频、视频资源
  • MyNovel/Views/MainView.cs——主窗口(通常不需要改)

运行项目 ​

用 .NET CLI ​

bash
# 在核心项目目录下
cd MyNovel/MyNovel
dotnet run

用 SDK ​

在 SDK 中打开项目,点击「运行」按钮。

入口剧本 ​

引擎启动后会加载 Stories/title/title_main.story 中的 title_main 场景。这是你的游戏的入口点。

打开 Stories/title/title_main.story,你会看到类似这样的内容:

dsl
scene "title_main" type=menu
  text "我的游戏" x=50% y=40% size=48 color="#FFD700" halign=center
  button "开始游戏" x=50% y=55% width=200 height=44 color="#88CCFF" nav="chapter1" halign=center

试着修改标题文字,保存后重新运行,看看效果!

常见问题 ​

Q: 运行后白屏或黑屏? ​

检查 Stories/title/title_main.story 是否存在,且包含 scene "title_main" 定义。

Q: 找不到 DLL? ​

确保 MyNovel/DLL/ 目录下有引擎的三个 DLL:

  • LingFanEngine.Abstractions.dll
  • LingFanEngine.DslCore.dll
  • LingFanEngine.dll

Q: 中文乱码? ​

确保 .story 文件以 UTF-8 编码保存。

下一步 ​

环境准备好了!接下来创建你的第一个场景。

基于 .NET 10 + Avalonia 12 · Apache-2.0 License