Skip to content

安装

前置准备

在开始之前,请确保你的电脑上已经安装了 Node.js(版本 20 或以上)。你可以在终端中输入以下命令来检查:

shell
node -v

如果显示了 v20.x.x 或更高版本号,说明环境已经就绪。

克隆仓库

打开终端,使用 Git 克隆仓库到本地,然后进入项目文件夹:

shell
git clone https://github.com/jerry-sourcecode/advmaker.git
cd advmaker

安装依赖

在项目根目录下运行以下命令安装所有必要的依赖包:

shell
npm install

启动开发服务器

依赖安装完成后,启动开发服务器:

shell
npm run dev

稍等片刻,终端会提示你打开浏览器访问(通常是 http://localhost:5173)。现在你应该能看到游戏启动界面了!

其他可用指令:

shell
# 构建生产版本
npm run build
# 预览构建后的产物
npm run preview

项目预览

当你完成安装后,应该会在根目录下有一个 src 文件夹,其内部结构如下:

src
├── main.ts        # Vue 应用入口,负责挂载整个游戏
├── App.vue        # 游戏的根组件,是游戏运行的核心容器
└── game.config.ts # 项目的全局配置
  • src 文件夹是你施展创意的地方。所有放在这里的 .ts 文件都会被自动编译并执行,你可以自由地新增文件来组织你的故事。
  • main.ts 是 Vue 应用的入口文件。它创建 Vue 实例、挂载 Pinia 状态管理,并将 App.vue 挂载到页面上。
  • App.vue 是游戏的根组件。它的核心是 <AShell> 组件——这是整个游戏的容器,负责渲染游戏界面(标题栏、状态栏、对话区域、菜单面板等),以及收集和组织你的故事内容。项目必须有一个包含 <AShell>App.vue 才能正常运行。 你可以在 <AShell> 内部使用故事组件来编排剧情,也可以在独立的 .ts 文件中通过 API 编写故事,两种方式可以混合使用。
  • game.config.ts 是项目的全局配置,用于设定游戏名称、入口场景等。