AR.js 开源项目使用教程

2026-01-16 09:22:21作者：管翌锬

1. 项目目录结构及介绍

AR.js是一个基于Web的增强现实轻量级库，它支持图像跟踪、位置基础的AR以及标记跟踪。以下是其基本的目录结构概览：

aframe: 包含了针对A-Frame框架的组件和封装，使得在HTML中通过自定义组件创建AR体验变得简单。
three.js: 涵盖了AR.js的核心部分，针对使用Three.js进行渲染的场景，包括标记基础和图像跟踪的例子。
jsartoolkit5: 这是AR.js用于追踪的基础库，处理现实世界中的标记识别。
src: 存放AR.js的核心源代码。
build: 分别有针对A-Frame和Three.js的不同构建版本，用户可以根据需求选择导入相应的脚本。
examples: 提供了一系列示例，帮助开发者快速上手，包括如何使用NFT（New Feature Tracking）、地点基础的AR应用等。

2. 项目的启动文件介绍

AR.js并不提供一个统一的“启动文件”让项目立刻运行，而是鼓励用户根据其应用场景选择合适的库（A-Frame或Three.js）并引入对应版本的AR.js库。以下是如何开始一个新的AR项目的基本步骤：

对于A-Frame版本，你的入口文件可能会类似于HTML模板，其中包含AR.js的引入和必要的A-Frame元素，例如：

<!DOCTYPE html>
<html>
<head>
    <script src="https://aframe.io/releases/1.2.0/aframe.min.js"></script>
    <script src="https://raw.githack.com/AR-js-org/AR.js/master/aframe/build/aframe-ar-nft.js"></script>
</head>
<body>
    <!-- AR体验代码将放在这里 -->
</body>
</html>

对于Three.js版本，虽然流程相似，但你可能需要手动管理更多的Three.js依赖和AR.js的Three.js构建。

3. 项目的配置文件介绍

AR.js的配置主要不是通过独立的配置文件完成，而是在HTML文件中或者通过JavaScript直接设置属性来实现。比如，在A-Frame场景中，AR.js的配置通常嵌入在<a-scene>标签的属性内，如下所示：

<a-scene vr-mode-ui="enabled: false" 
         renderer="logarithmicDepthBuffer: true, precision: medium" 
         embedded 
         arjs="trackingMethod: best; sourceType: webcam; debugUIEnabled: false">
    <!-- AR体验的内容将会被添加到这里 -->
</a-scene>