WebXR Emulator Extension 使用教程

1. 项目目录结构及介绍

WebXR Emulator Extension 项目的目录结构如下：

WebXR-emulator-extension/
├── assets/
│   └── icons/
├── polyfill/
│   └── webxr-polyfill.js
├── screenshots/
├── src/
│   ├── background.js
│   ├── content.js
│   ├── devtools.js
│   ├── panel.js
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── manifest.json
├── package.json
└── rollup.config.js

目录结构介绍

• assets/: 存放项目所需的静态资源文件，如图标等。
• polyfill/: 包含 WebXR API 的 polyfill 文件，用于在不支持 WebXR 的浏览器中模拟 WebXR API。
• screenshots/: 存放项目的截图文件。
• src/: 项目的源代码目录，包含主要的 JavaScript 文件和模块。
  • background.js: 后台脚本，处理浏览器扩展的后台逻辑。
  • content.js: 内容脚本，注入到 WebXR 应用页面中，处理页面内容。
  • devtools.js: 开发者工具面板的脚本，用于控制模拟设备。
  • panel.js: 开发者工具面板的 UI 组件。
• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• manifest.json: 浏览器扩展的配置文件，定义扩展的元数据和权限。
• package.json: Node.js 项目的配置文件，包含项目的依赖和脚本。
• rollup.config.js: Rollup 打包工具的配置文件，用于构建项目。

2. 项目启动文件介绍

WebXR Emulator Extension 的启动文件主要包括 background.js 和 content.js。

background.js

background.js 是浏览器扩展的后台脚本，负责处理扩展的后台逻辑。它通常用于监听浏览器事件、管理扩展的状态和与内容脚本通信。

content.js

content.js 是内容脚本，注入到 WebXR 应用页面中。它负责与页面内容交互，模拟 WebXR API 的行为，并将模拟结果传递给开发者工具面板。

3. 项目的配置文件介绍

manifest.json

manifest.json 是浏览器扩展的配置文件，定义了扩展的元数据、权限、背景脚本、内容脚本等信息。以下是 manifest.json 的主要内容：

{
  "manifest_version": 2,
  "name": "WebXR Emulator",
  "version": "0.3.3",
  "description": "WebXR Emulator extension enables users and developers to run and test WebXR content in desktop browsers without using a real XR device.",
  "permissions": [
    "webRequest",
    "webRequestBlocking",
    "<all_urls>"
  ],
  "background": {
    "scripts": ["src/background.js"]
  },
  "content_scripts": [
    {
      "matches": ["<all_urls>"],
      "js": ["src/content.js"]
    }
  ],
  "devtools_page": "src/devtools.html",
  "icons": {
    "48": "assets/icons/icon48.png",
    "128": "assets/icons/icon128.png"
  }
}

package.json

package.json 是 Node.js 项目的配置文件，包含项目的依赖和脚本。以下是 package.json 的主要内容：

{
  "name": "webxr-emulator-extension",
  "version": "0.3.3",
  "description": "WebXR emulator extension",
  "main": "src/background.js",
  "scripts": {
    "build": "rollup -c rollup.config.js"
  },
  "dependencies": {
    "webxr-polyfill": "^2.0.0"
  },
  "devDependencies": {
    "rollup": "^2.0.0"
  }
}

rollup.config.js

rollup.config.js 是 Rollup 打包工具的配置文件，用于构建项目。以下是 rollup.config.js 的主要内容：

import resolve from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';

export default {
  input: 'src/main.js',
  output: {
    file: 'dist/bundle.js',
    format: 'iife'
  },
  plugins: [
    resolve(),
    commonjs()
  ]
};

通过以上配置文件，可以了解项目的构建和运行方式，以及扩展的基本功能和权限。