# BoringVisualNovel

**Repository Path**: MantleAPI/boring-visual-novel

## Basic Information

- **Project Name**: BoringVisualNovel
- **Description**: 因为太无聊了，花了一天时间做了个没啥用的视觉小说脚本。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 1 引言

这个项目叫《因为太过无聊所以做了个视觉小说脚本》。

# 2 使用方法

## 2.1 导入依赖 

项目引用了：

- Vue.js
- jQuery 2.1.1

请务必在使用时引入上述两个库，最后再引入 js / visual-novel.js

```html
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
<script src="http://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js" type="text/javascript" charset="utf-8"></script>
<script src="js/visual-novel.js" type="text/javascript" charset="utf-8"></script>
```

同时，记得引用 css / visual-novel-default.css

```html
<link rel="stylesheet" href="css/visual-novel-default.css">
```

## 2.2 函数

使用函数之前，要先了解本项目视觉小说的结构。每一句由 “名称+这个人说的话” 组成。比如：`【张三】你好，我叫张三。`名称为“【张三】”，这个人说的话为“你好，我叫张三”。

- showCursor(flag, millisecond = 800)

  ​	flag: 设置是否在文本后面显示光标，

  ​	millisecond: 设置光标闪烁的时间间隔（默认为800毫秒）。

- setName(name)

  ​	name: 设置说话的人的名称。

- setText(text, color)

  ​	text: 设置剧本，接收类型为字符串数组。

  ​	color: 设置文本颜色（可选）。

- setColor(color)

  ​	color: 设置文本颜色。

- showText(millisecond = 2000, name, text, color)

  ​	millisecond: 设置显示每行文本的间隔。

  ​	name: 设置说话的人的名称。若已通过setName()设置名称则可省略。

  ​	text: 设置剧本，接收类型为字符串数组。若已通过setText()设置剧本则可省略。

  ​	color: 设置文本颜色（可选）。

使用例见 js / main.js

```javascript
showCursor(true);
showText(millisecond = 2000, name = '【张三】  ', text = ["你好你好你好你好",
														 "再见再见再见再见"],
												 color = 'green');
```

## 2.3 样式

- .novel

  ​	小说整体样式。

- .cursor

  ​	光标样式。

- .msg

  ​	每行字符串的样式。

# 3 更新日志

- 2020/10/14	—	很无聊，花了一天时间做出来的。