# 快速上手

# 使用前提

Naninovel是 Unity游戏引擎 扩展资源,所以确保你在对Unity有基本了解以后再开始使用本扩展。

使用这套资源以前应该有对Unity的基础了解:

加入你要创建任何和本扩展无关的场景,可以忽略场景相关的提示信息,因为它们都会用本扩展来协调处理。

# 核心概念

开始使用之前,我们快速浏览一些核心概念。

首先很关键的一个概念,在本教程中你会频繁遇到的-- 演出元素(Actor),他是由多种参数ID,外观,场景中位置,等其他参数构成。

演出元素(Actor)是抽象概念,部分演出元素(Actor)有其特殊的参数比如:

演出元素(Actor) 额外参数 描述
人物 Look Direction 场景中人物立绘
背景 None 场景中背景,默认置于人物例会之后显示
打字机 随时间显示文字
选择处理器 Choices 让玩家选择选项

典型VN游戏,由人物和其背景组成。在Naninovel规范里,由以下方式呈现。

现在,我们想让"Kohaku" 呈现高兴的样子。我们有不同表情的立绘。在 Naninovel这种图像的元素,称为演出元素(Actor)的外观appearances。 要达到这个目的,我们就得改变人物演出元素的外观,背景演出元素同理。

演出元素(Actor)直接由 naninovel 脚本 来控制。

另一个广泛使用的概念是演出元素,UI界面 (UI)。包含玩家和演出元素的交互,有各种各样的菜单(标题画面,保存读取窗口,设置窗口等),以及控制面板(自动阅读切换,跳过文本等)。UI元素默认置于所有演出元素之上。

打字机和选择处理两个元素可视为UI元素,可以由Naninovel 脚本控制,用于玩家和游戏的交互。

如果你熟悉编程,可以参阅:引擎结构 了解本资源的程序设计理念。

# 创建新Unity项目:

了解到核心概念之后,开始第一步,创建新项目,可以从 Unity 手册 学习如何创建新项目。

创建时使用2D Template 免得频繁手动修改导入图片素材的Import settings。也可以创建后在 project settings 手动修改。

新场景Sample Scene内的Main Camera和Directional Light可以删除,本资源是完全和场景不关联的,默认新建的Sample Scene都可以删除,但是建议至少留下一个空场景,保证内置功能正常运行。

# 安装 Naninovel

Asset Store 窗口 下载并等待导入编译完成。Naninovel资源的文件夹位置可以在资源文件夹内随意移动。

在使用该资源各项功能(配置,设置,保存等)后会自动生成文件夹 Assets/NaninovelData 。 和上面相反,不要移动该目录(移动后再运行是会重新生成),如果你想改变该目录, 编辑引擎配置菜单中的 Generated Data Path

# 添加Naninovel 脚本

使用 Create -> Naninovel -> Naninovel Script来创建新的naninovel script。

Create Naninovel Script

注意

以下示例仅供参考,文件夹和其他资源位置,命名等随意,按使用者自己需求

Naninovel脚本是文本文件(扩展名为.nani),用于控制你场景的演出,你可以使用任何文本编辑器进行修改,比如Notepad,TextEdit,或者 VS Code.

Open Naninovel Script

也可使用内置可视化编译器进行编辑。 在选择创建好的脚本以后,在右侧的属性面板会自动打开内置的可视化编辑器。

在右侧编辑器内按右键insert或者Ctrl+Space以插入新行 (可以之后再输入配置菜单自定义快捷键) 然后选择想要的命令行,过直接输入左边的编号,或是直接拖拽来重新排序已有的行,在右侧编辑器内按右键remove移除已有行。

上方修改文件名会有(*) 符号显示,按Ctrl+S 保存修改,未保存当前文件修改去改动其他脚本时会有提示询问是否保存。

使用其他编译器编译时候注意保存修改,内置可视化编辑器会自动同步修改,所以你可以同时使用文本编辑器和内置可视化编辑器。

注意

以下指引中均使用的文本编辑器,你可以直接再内置可视化编辑器中实现一样的修改。

在Naninovel -> Resources -> Scripts内按“+”号添加外部脚本,也可以通过拖拽添加,支持文件夹拖拽,确保所有要使用的脚本被添加进来,通过菜单创建的会自动被添加。

Add Naninovel Script

打开已经创建的脚本输入如下信息:

Hello World!
@stop

启动场景可以看到运行效果,显示第一句话后,随机根据第二句停止。

注意

所有可用内置命令,参数,示例参考API 参考 。你也可以添加自定义命令,参考自定义命令

万一主菜单的"NEW GAME" 按钮没被激活,确认脚本配置菜单 (Naninovel -> Configuration -> Scripts) 内 Start Game Script属性正确配置,名字是创建的要使用的第一个脚本名字。如果你导入了其他已有脚本,该配置可能不会自动配置,正常创建第一个脚本时,该属性会被自动配置。

# 添加人物

本资源可使用人物类型为,2D Sprites,动态Live2D模型3D meshes,你可以导入自己的资源使用,教程里使用2D Sprites。

在Naninovel -> Resources -> Characters 配置要使用的人物资源,每个人物由ID名称和对应的资源构成。支持拖拽添加。

Add Character

假定添加角色ID为"Kohaku"。编辑naninovel script来显示角色:

@char Kohaku
Hello World!
@stop

运行游戏时你会看到显示在屏幕上的人物,如果不指定特定资源名,会使用默认的显示资源。在脚本中使用“.”来调用对应的人物资源如下所示:

@char Kohaku.Happy
Hello World!
@stop

这样就会显示名字是"Happy" 的"Kohaku"元素图像,而不是默认的图像.

可使用如下方式使用“:”关联显示的对应文本:

@char Kohaku.Happy
Kohaku: Hello World!
@stop

或者:

Kohaku.Happy: Hello World!
@stop

要从场景中隐藏(移除)某个角色,或是其他演出元素如背景等,使用@hide :

Kohaku.Happy: Hello World!
@hide Kohaku
@stop

# 添加背景

背景可用Sprite,generic object,video,scene,也可用自定义工具物体;

你可以创建多个独立演出元素的背景,在一般VN游戏中,我们通常看到的效果是不同背景之间的切换。为了简化操作,MainBackground是预先添加好在背景演出元素中的的,也就不用每次在脚本中声明id,自动调用MainBackground内的背景。

Naninovel -> Resources -> Backgrounds在此菜单内添加新背景,默认打开MainBackground条目在此添加,你也可以返回上一级添加其他演出元素添加新的条目。

Add Background

假定背景名为 "City"。使用@back 命令按如下调用:

@back City 

切换时会使用默认切换效果,详情参考切换效果 。调用如下,使用径向模糊:

@back City 
@back School.RadialBlur

如此就会从 "City" 径向渐变到 "School"。

不同条目下的同名背景调用需要定义ID,如下:

@back Flower id:Flower
@back Withered id:Flower

# 添加音乐和音效

Naninovel -> Resources -> Audio内添加音效;Unity支持的格式参考Unity支持格式.

Managing Audio

BGM默认循环播放,使用渐隐切换过去,音量循环等可以使用参数改动,用@bgm命令基本调用如下:

@bgm ThePromenade

音效默认播放一次,@sfx命令调用如下:

@sfx Explosion

# 视频教程

如果你想看视频教程,如下:

# 演示项目

GitHub完整Demo资源地址:github.com/Naninovel/Demo.

可以使用Git客户端克隆库 或者 作为zip档案下载。 Demo仅供学习使用。

警告

Demo不包含扩展,导入会报错,从Asset Store导入后解决报错。

最近更新时间: 2020年12月19日