BiliTools 项目使用教程

BiliTools 项目使用教程

BiliTools A cross-platform bilibili toolbox. 跨平台哔哩哔哩工具箱，支持视频、音乐、番剧、课程下载……持续更新 项目地址: https://gitcode.com/gh_mirrors/bilit/BiliTools

1. 项目目录结构及介绍

BiliTools 的目录结构如下：

BiliTools/
├── .github/              # GitHub 工作流和模板
├── .vscode/              # Visual Studio Code 配置文件
├── assets/               # 资源文件，如图片、样式表等
├── patches/              # 补丁文件
├── scripts/              # 脚本文件
├── src-tauri/            # 使用 Tauri 框架的源码目录
├── src/                  # 源代码目录
├── .gitattributes         # Git 属性配置文件
├── .gitignore            # Git 忽略文件配置
├── CHANGELOG.md          # 项目更新日志
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── install.json          # 安装配置文件
├── package-lock.json     # npm 锁定文件
├── package.json          # npm 项目配置文件
├── tailwind.config.js    # Tailwind CSS 配置文件
├── tsconfig.json         # TypeScript 配置文件
├── tsconfig.node.json    # TypeScript Node 配置文件
└── vite.config.ts        # Vite 配置文件

各目录和文件简要说明：

• .github/: 包含 GitHub Actions 工作流和 Issue 模板等。
• .vscode/: 包含 Visual Studio Code 的项目配置。
• assets/: 存放项目所需的静态资源文件，如图片、样式表等。
• patches/: 存放补丁文件，用于修复特定问题。
• scripts/: 包含项目构建和开发过程中使用的脚本文件。
• src-tauri/: 包含使用 Tauri 框架开发的源码。
• src/: 包含主要的源代码文件，如 TypeScript、JavaScript、Vue 组件等。
• .gitattributes: 指定如何处理特定的文件类型。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录了项目的所有更新和修改。
• LICENSE: 项目所使用的许可证信息。
• README.md: 项目的基本介绍和使用说明。
• install.json: 包含项目安装时的一些配置信息。
• package-lock.json: 记录了项目依赖的精确版本。
• package.json: 定义了项目的依赖、脚本和其他元数据。
• tailwind.config.js: Tailwind CSS 的配置文件。
• tsconfig.json: TypeScript 的配置文件。
• tsconfig.node.json: 为 Node.js 环境指定 TypeScript 配置。
• vite.config.ts: Vite 的配置文件。

2. 项目的启动文件介绍

BiliTools 项目的启动主要是通过 src-tauri/ 目录下的 main.rs 文件进行的。这个文件是 Rust 语言编写的，是 Tauri 应用程序的入口点。以下是 main.rs 文件的基本结构：

fn main() {
    // 初始化日志系统
    // 配置应用程序
    // 运行应用程序
}

在 main.rs 文件中，会初始化日志系统，配置 Tauri 应用程序，并启动它。

此外，前端部分的启动是通过 src/ 目录下的 main.ts 文件进行的。这个文件是 TypeScript 语言编写的，以下是 main.ts 文件的基本结构：

// 引入必要的模块和依赖
// 初始化 Vue 应用程序
// 挂载 Vue 应用程序到 DOM

在 main.ts 文件中，会引入 Vue 相关的模块和依赖，创建 Vue 应用程序实例，并将其挂载到 DOM 上。

3. 项目的配置文件介绍

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

• package.json: npm 项目的配置文件，定义了项目的依赖、脚本和其他元数据。例如，可以定义项目的启动脚本、构建脚本等。

{
  "scripts": {
    "start": "vite",
    "build": "vite build",
    "tauri": "tauri dev"
  }
}

• tailwind.config.js: Tailwind CSS 的配置文件，用于定制 CSS 样式。

module.exports = {
  // 配置内容
};

• tsconfig.json: TypeScript 的配置文件，用于指定 TypeScript 编译器的选项。

{
  "compilerOptions": {
    // 编译器选项
  }
}

• vite.config.ts: Vite 的配置文件，用于配置 Vite 的行为。

import { defineConfig } from 'vite';

export default defineConfig({
  // Vite 配置
});

通过这些配置文件，开发者可以自定义项目的行为，比如指定构建过程、定义样式规则、配置 TypeScript 编译选项等。

BiliTools A cross-platform bilibili toolbox. 跨平台哔哩哔哩工具箱，支持视频、音乐、番剧、课程下载……持续更新 项目地址: https://gitcode.com/gh_mirrors/bilit/BiliTools