Beatmapper项目教程

1. 项目目录结构及介绍

Beatmapper项目是一个用于创建Beat Saber地图的3D编辑器。以下是项目的目录结构及其简要介绍：

• .vscode: 存储Visual Studio Code编辑器的配置文件。
• bin: 可执行文件和脚本目录。
• config: 配置文件目录。
• public: 公共静态文件目录，如图片、样式表等。
• scripts: 脚本文件目录，包含启动、构建等脚本。
• src: 源代码目录，包括所有项目的JavaScript和TypeScript代码。
• .gitignore: 指定Git版本控制时需要忽略的文件和目录。
• LICENSE.md: MIT许可协议文件。
• README.md: 项目说明文件。
• netlify.toml: Netlify部署配置文件。
• offsets.md: 偏移量配置文件。
• package.json: 项目配置文件，包含项目依赖和脚本。
• preview.png: 项目预览图。
• timing.md: 时间配置文件。
• tsconfig.json: TypeScript配置文件。
• yarn.lock: yarn依赖锁文件。

2. 项目的启动文件介绍

项目的启动主要通过package.json中的脚本实现。以下是一些主要的启动脚本：

• start: 启动开发服务器。
• build: 构建项目生产环境的静态文件。
• test: 运行测试。

您可以通过以下命令启动开发服务器：

yarn start

或者在Windows环境下：

npm start

这将启动一个本地服务器，并自动在浏览器中打开项目。

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• package.json: 这个文件包含了项目的所有配置信息，包括项目名称、版本、描述、依赖项、脚本等。
• tsconfig.json: TypeScript配置文件，定义了TypeScript编译器的选项，如模块系统、编译选项等。
• .vscode/settings.json: Visual Studio Code的配置文件，可以自定义编辑器的各种设置。

确保在开始项目之前，根据您的开发环境和需求，正确配置这些文件。