ADV.JS 开源项目教程

ADV.JS 开源项目教程

advjs 🎮 ADV.JS Web AVG Engine 面向未来与前端的文字冒险游戏引擎（WIP） 项目地址: https://gitcode.com/gh_mirrors/ad/advjs

1. 项目介绍

ADV.JS 是一个面向未来与前端的文字冒险游戏引擎，旨在帮助开发者轻松创建基于 Web 的文字冒险游戏。该项目采用现代前端技术栈，如 Vue、TypeScript 等，提供了一套完整的工具链，包括脚本解析器、编辑器、VRM 模型编辑器等，帮助开发者从零开始构建自己的文字冒险游戏。

2. 项目快速启动

安装依赖

首先，确保你已经安装了 Node.js 和 pnpm。然后，通过以下命令克隆项目并安装依赖：

git clone https://github.com/YunYouJun/advjs.git
cd advjs
pnpm install

启动开发服务器

安装完成后，你可以通过以下命令启动开发服务器：

pnpm dev

创建新项目

使用 create-adv 脚手架创建一个新的 ADV 项目：

pnpm create adv your-adv
cd your-adv
adv your-adv.md

3. 应用案例和最佳实践

应用案例

ADV.JS 已经被用于多个文字冒险游戏的开发，例如《未来之约》、《星际迷航》等。这些游戏通过 ADV.JS 提供的强大功能，实现了丰富的剧情和交互体验。

最佳实践

• 模块化开发：利用 ADV.JS 的模块化设计，将游戏的不同部分（如 UI、剧情、角色等）拆分为独立的模块，便于维护和扩展。
• 使用 Markdown 编写剧本：ADV.JS 支持使用 Markdown 编写游戏剧本，开发者可以通过扩展语法实现复杂的剧情分支和角色互动。
• 集成 VRM 模型：通过 ADV.JS 的 VRM 模型编辑器，开发者可以轻松导入和编辑 3D 角色模型，增强游戏的视觉表现力。

4. 典型生态项目

ADV.JS 核心模块

• @advjs/core：提供 ADV.JS 的核心功能，包括 UI 样式和文本解析。
• @advjs/theme-default：默认的主题样式，开发者可以根据需要进行自定义。

编辑器

• @advjs/editor：可视化编辑器，集成各类功能，帮助开发者快速构建游戏内容。
• @advjs/vscode：VSCode 插件，提供对 .adv.md 文件的语法高亮和提示。

其他工具

• @advjs/parser：剧本解析器，支持 Markdown 及扩展语法，生成语法树。
• @advjs/vrm：VRM 模型在线编辑器，用于编辑 3D 角色模型。

通过以上模块和工具，开发者可以构建出功能丰富、交互性强的文字冒险游戏。

advjs 🎮 ADV.JS Web AVG Engine 面向未来与前端的文字冒险游戏引擎（WIP） 项目地址: https://gitcode.com/gh_mirrors/ad/advjs