VRCMelonAssistant 项目安装与使用指南

1. 项目目录结构及介绍

VRCMelonAssistant 项目的目录结构如下：

VRCMelonAssistant/
├── assets/              # 存放项目资源文件
├── Documents/           # 包含项目文档和教程
├── Examples/            # 示例代码和项目
├── Libraries/           # 项目依赖的库文件
├── MelonLoader/         # MelonLoader 相关文件，用于在 VRChat 中加载插件
├── Plugins/             # 项目的主插件文件
├── Properties/          # 存储项目的配置信息
├── Scripts/             # 项目的主要脚本文件
├── Tests/               # 单元测试和测试代码
├── UnityProj/           # Unity 项目文件，用于开发和构建
├──Assets/               # Unity 项目中的资源文件夹
├──Documentation/        # 项目的文档资料
└── README.md            # 项目说明文件

每个目录的功能简要说明如下：

• assets/: 存放项目所需的各种资源文件，如图像、音频等。
• Documents/: 包含项目的文档和教程，帮助用户理解和使用项目。
• Examples/: 提供了一些示例代码和项目，帮助用户更好地学习如何使用 VRCMelonAssistant。
• Libraries/: 存放项目依赖的第三方库文件。
• MelonLoader/: 包含 MelonLoader 相关的文件，用于在 VRChat 中加载和使用插件。
• Plugins/: 项目的主插件文件所在目录，是项目功能的核心部分。
• Properties/: 存储项目的配置信息，如数据库连接字符串等。
• Scripts/: 项目的主要脚本文件，负责实现项目的业务逻辑。
• Tests/: 包含单元测试和测试代码，确保项目的稳定性和可靠性。
• UnityProj/: Unity 项目文件，用于开发和构建项目。
• Assets/: Unity 项目中的资源文件夹，与 UnityProj 相关联。
• Documentation/: 包含项目的文档资料，提供更详细的项目信息。
• README.md: 项目说明文件，通常包含项目的简介、安装和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要位于 UnityProj/ 目录下的 Unity 项目中。在 Unity 编辑器中，通常会有一个主场景文件（例如 MainScene.unity），该文件包含了启动项目所需的所有基础设置和资源。

启动项目时，通常需要执行以下步骤：

1. 打开 Unity 编辑器。
2. 通过 "File" 菜单选择 "Open Project"，然后选择 UnityProj/ 目录。
3. 在 Unity 编辑器中，选择 MainScene.unity 场景。
4. 点击 "Start" 按钮来启动场景。

在 Plugins/ 目录下的主插件文件，例如 VRCMelonAssistant.dll，会在 Unity 场景加载时自动被 MelonLoader 识别和加载。

3. 项目的配置文件介绍

项目的配置文件通常位于 Properties/ 目录下。配置文件可能包括以下几种：

• config.json: 项目的通用配置文件，可能包含数据库连接信息、API密钥等。
• settings.ini: 可能包含一些基本的项目设置，如界面主题、语言等。

配置文件的具体内容可能如下所示：

{
  "database": {
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "dbname": "vrcmelonassistant"
  },
  "api_keys": {
    "api_name": "API_KEY_HERE"
  }
}

或者：

[General]
theme = dark
language = en-US

在使用项目前，需要确保配置文件中的信息正确无误，以避免在运行时遇到问题。配置文件通常可以通过编辑器直接编辑，也可以在项目启动时通过代码动态加载和修改。