Tempusxr English
Menu
  1. Documentation
  2. Pour commencer

Installer le SDK

Le SDK Tempusxr est gratuit et ne demande ni clé ni compte aujourd'hui. Choisissez la voie qui convient à votre projet. Chacune donne la même expérience.

1. Une page HTML simple avec A-Frame : trois fichiers

Pas d'étape de build. Copiez cette page, remplacez la cible et le contenu, puis ouvrez-la depuis une adresse HTTPS (les téléphones exigent HTTPS pour la caméra).

<script src="https://aframe.io/releases/1.8.0/aframe.min.js"></script>
<script src="https://tempusxr.vercel.app/v1/tempusxr-aframe.min.js"></script>
<script src="https://tempusxr.vercel.app/v1/tempusxr-image.min.js"></script>

<a-scene tempusxr="tracker: image; targets: targets.txr" renderer="alpha: true" vr-mode-ui="enabled: false">
  <a-camera look-controls="enabled: false" wasd-controls="enabled: false"></a-camera>
  <a-entity tempusxr-image-target="index: 0">
    <a-box position="0 0 0.15" scale="0.3 0.3 0.3" color="#fecb02"></a-box>
  </a-entity>
</a-scene>

Les trois fichiers sont A-Frame, Tempusxr pour A-Frame (il contient aussi le chargeur de fichiers de scène et la capture photo et vidéo), et le traqueur. Fabriquez targets.txr avec le compilateur d'images. Essayez la page : trois fichiers, A-Frame.

2. Une page HTML simple avec Three.js : trois fichiers

<script type="importmap">
  {
    "imports": {
      "three": "https://cdn.jsdelivr.net/npm/three@0.187.0/build/three.module.js",
      "three/addons/": "https://cdn.jsdelivr.net/npm/three@0.187.0/examples/jsm/",
      "@tempusxr/sdk-core": "https://tempusxr.vercel.app/v1/tempusxr-three.esm.js",
      "@tempusxr/sdk-three": "https://tempusxr.vercel.app/v1/tempusxr-three.esm.js"
    }
  }
</script>
<div id="ar"></div>
<script type="module">
  import { create } from '@tempusxr/sdk-three';
  import 'https://tempusxr.vercel.app/v1/tempusxr-image.esm.js';

  const ar = create({ container: '#ar' });
  const tracker = await ar.use('image', { targets: ['targets.txr'] });
  ar.attach(tracker.anchors[0], monObjetThree);
  await ar.start();
</script>

Les trois fichiers sont Three.js, Tempusxr pour Three.js (cœur, chargeur de fichiers de scène, capture), et le traqueur. Les deux lignes @tempusxr désignent le même fichier exprès : un fichier de traqueur demande @tempusxr/sdk-core et doit retrouver exactement le même module. La ligne three/addons/ n'est lue que par une scène qui utilise des modèles compressés en Draco ou KTX2. Essayez la page : trois fichiers, Three.js.

3. npm

npm install @tempusxr/sdk-three @tempusxr/sdk-tracker-image three
# ou, pour A-Frame
npm install @tempusxr/sdk-aframe @tempusxr/sdk-tracker-image aframe
import { create } from '@tempusxr/sdk-three';
import '@tempusxr/sdk-tracker-image'; // enregistre le traqueur 'image'

Three.js et A-Frame sont des dépendances « peer » : vous choisissez la version. Les paquets sont @tempusxr/sdk-core, sdk-three, sdk-aframe, sdk-capture, scene (le format des fichiers de scène) et un paquet par traqueur. Ils sont livrés minifiés, avec leurs types.

4. Un fichier de scène : décrire l'expérience en JSON

Au lieu d'écrire le contenu en HTML ou en JavaScript, vous pouvez décrire toute l'expérience dans un fichier de scène (quoi suivre, quoi montrer, ce qui se passe au toucher) et l'ouvrir en une ligne. Cela marche avec les trois voies ci-dessus, avec les mêmes trois fichiers ou les mêmes paquets npm. Rien de plus à installer.

A-Frame : un seul attribut ouvre la scène.

<script src="https://aframe.io/releases/1.8.0/aframe.min.js"></script>
<script src="https://tempusxr.vercel.app/v1/tempusxr-aframe.min.js"></script>
<script src="https://tempusxr.vercel.app/v1/tempusxr-image.min.js"></script>

<a-scene tempusxr-scene="src: scene.json" renderer="alpha: true" vr-mode-ui="enabled: false">
  <a-camera look-controls="enabled: false" wasd-controls="enabled: false"></a-camera>
</a-scene>

Three.js ou npm : un seul appel.

import { loadScene } from '@tempusxr/sdk-three';
import '@tempusxr/sdk-tracker-image'; // et '@tempusxr/sdk-tracker-world' pour une scène au sol ou sur un mur

const experience = await loadScene('scene.json', { container: '#ar' });
startButton.addEventListener('click', () => experience.start()); // depuis un toucher, pour que le son et la vidéo puissent jouer

Une scène qui suit le sol ou un mur demande le fichier du traqueur world (tempusxr-world.min.js ou tempusxr-world.esm.js) à la place de celui d'image, ou en plus. La scène dit lequel il lui faut, et la page vous prévient s'il manque.

Écrivez la vôtre en cinq minutes : Votre premier fichier de scène. Le format est dans Format de scène v1, et des scènes prêtes à copier sont dans la Bibliothèque d'expériences : ouvrez une expérience et choisissez son lien Fichier de scène.

Les traqueurs

Une page ne charge que le suivi qu'elle utilise, un fichier chacun.

SuiviA-Frame ou balise scriptModule Three.jsnpm
Imagetempusxr-image.min.jstempusxr-image.esm.js@tempusxr/sdk-tracker-image
Monde (sol et murs, Chrome Android)tempusxr-world.min.jstempusxr-world.esm.js@tempusxr/sdk-tracker-world
Visage, main, corpsà venirà venirà venir

Versions

/v1/ contient toujours la dernière version 1.x. Pour une version qui ne change jamais, utilisez son dossier, par exemple /v0.1.0-beta/. Les fichiers sont servis avec un CORS ouvert et se chargent depuis n'importe quel site.

Licence

Gratuit, y compris en usage commercial, sans clé pour l'instant. Le code n'est pas open source : vous ne pouvez ni le copier ni le revendre. Lisez LICENSE.md dans chaque paquet. Des formules avec clé SDK sont prévues ; elles ne casseront pas les versions que vous utilisez aujourd'hui.