@srsergio/taptapp-ar 1.1.7 โ†’ 1.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +69 -30
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,11 +1,23 @@
1
- # @srsergio/taptapp-ar
1
+ <div align="center">
2
+
3
+ # ๐ŸŽฏ @srsergio/taptapp-ar
2
4
 
3
- [![npm version](https://img.shields.io/npm/v/@srsergio/taptapp-ar.svg?style=flat-square)](https://www.npmjs.com/package/@srsergio/taptapp-ar)
4
- [![npm downloads](https://img.shields.io/npm/dm/@srsergio/taptapp-ar.svg?style=flat-square)](https://www.npmjs.com/package/@srsergio/taptapp-ar)
5
+ <img src="./docs/images/hero-banner.png" alt="TapTapp AR - High Performance Augmented Reality" width="100%"/>
6
+
7
+ [![npm version](https://img.shields.io/npm/v/@srsergio/taptapp-ar.svg?style=flat-square&color=00D4AA)](https://www.npmjs.com/package/@srsergio/taptapp-ar)
8
+ [![npm downloads](https://img.shields.io/npm/dm/@srsergio/taptapp-ar.svg?style=flat-square&color=7C3AED)](https://www.npmjs.com/package/@srsergio/taptapp-ar)
5
9
  [![License: Fair Source-0.9](https://img.shields.io/badge/License-Fair_Source--0.9-blue.svg?style=flat-square)](./LICENSE)
6
- [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@srsergio/taptapp-ar?style=flat-square)](https://bundlephobia.com/package/@srsergio/taptapp-ar)
10
+ [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@srsergio/taptapp-ar?style=flat-square&color=F59E0B)](https://bundlephobia.com/package/@srsergio/taptapp-ar)
11
+ [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
12
+ [![Zero Dependencies](https://img.shields.io/badge/Dependencies-Zero_TFJS-22C55E?style=flat-square)](https://www.npmjs.com/package/@srsergio/taptapp-ar)
13
+
14
+ ### ๐Ÿš€ Ultra-Fast AR Tracking โ€ข 100% Pure JavaScript โ€ข No TensorFlow Required
15
+
16
+ </div>
17
+
18
+ ---
7
19
 
8
- ๐Ÿš€ **TapTapp AR** is a high-performance Augmented Reality (AR) toolkit for **Node.js** and **Browser** environments. It provides an ultra-fast offline compiler and a lightweight runtime for image tracking.
20
+ **TapTapp AR** is a high-performance Augmented Reality (AR) toolkit for **Node.js** and **Browser** environments. It provides an ultra-fast offline compiler and a lightweight runtime for image tracking.
9
21
 
10
22
  **100% Pure JavaScript**: This package is now completely independent of **TensorFlow.js** for both compilation and real-time tracking, resulting in massive performance gains and zero-latency initialization.
11
23
 
@@ -16,35 +28,37 @@
16
28
  - [๐Ÿ›  Installation](#-installation)
17
29
  - [๐Ÿ“Š Industry-Leading Benchmarks](#-industry-leading-benchmarks-v7-moonshot)
18
30
  - [๐Ÿ›ก๏ธ Robustness & Stability](#๏ธ-robustness--stability-stress-tested)
19
- - [๐Ÿ–ผ๏ธ Compiler Usage](#๏ธ-compiler-usage-nodejs--web)
31
+ - [๐Ÿ–ผ๏ธ Compiler Usage](#๏ธ-compiler-usage-automatic--jit)
20
32
  - [๐ŸŽฅ Runtime Usage](#-runtime-usage-ar-tracking)
21
- - [A-Frame Integration](#1-simple-a-frame-integration)
22
- - [Three.js Wrapper](#2-high-performance-threejs-wrapper)
23
- - [Raw Controller](#3-raw-controller-advanced--custom-engines)
24
- - [Vanilla JS (SimpleAR)](#4-vanilla-js-no-framework-)
25
- - [๐Ÿ—๏ธ Protocol V7](#๏ธ-protocol-v7-moonshot-packed-format)
26
- - [๐Ÿ” Visual Search & Embeddings](#-visual-search--embeddings-new)
33
+ - [React Component](#1-the-easy-way-react-component-)
34
+ - [React Hook](#2-high-performance-react-hook-usear-)
35
+ - [Native API](#3-native-api-starttracking)
36
+ - [Custom Overlays](#4-custom-overlays-beyond-videoimages-)
37
+ - [Three.js / A-Frame](#5-advanced-integration-threejs--a-frame)
38
+ - [๐Ÿ—๏ธ Protocol V11](#๏ธ-protocol-v11-nanite-virtualized-format)
39
+ - [๐Ÿ” Visual Search & Embeddings](#-visual-search--embeddings-new-)
27
40
  - [๐Ÿ“„ License & Credits](#-license--credits)
28
41
 
29
42
  ---
30
43
 
31
44
  ## ๐ŸŒŸ Key Features
32
45
 
33
- - ๐ŸŽญ **Non-Rigid Surface Tracking**: Supports curved and deformable surfaces using **Delaunay Meshes** and **Mass-Spring Relaxation**.
34
- - ๐Ÿš€ **Nanite-style Virtualized Features**: Single-pass multi-octave detection with stratified sampling.
35
- - โšก **No TensorFlow Dependency**: No TFJS at all. Works natively in any JS environment (Node, Browser, Workers).
36
- - ๐Ÿงฌ **Fourier Positional Encoding**: Uses high-frequency sine/cosine mappings (GPT-style) for neural-like spatial consistency.
37
- - ๐Ÿš€ **Protocol V11 (Nanite)**:
38
- - **Stratified Multi-Octave Sampling**: 300 reliable features per octave, capped at 1,200 total per target.
39
- - **Dynamic Scale Filtering (LOD)**: Runtime matching engine skips irrelevant octaves based on estimated scale.
40
- - **4-bit Packed Tracking Data**: Grayscale images are compressed to 4-bit depth, slashing file size.
41
- - **64-bit LSH Descriptors**: Optimized Locality Sensitive Hashing with XOR folding support.
42
- - ๐Ÿงต **HD Precision Tracking**: Default resolution upgraded to **1280x960 (HD)** for superior sharpness on modern displays.
43
- - โšก **Zero-Config JIT Compilation**: No need for offline tools. Just pass an image URL and the engine compiles it on the fly.
44
- - ๐Ÿ“ **Virtualized Scale Range**: Stable tracking from **20% (distant targets)** to **1000% (close-up)** using a single high-res keyframe.
45
- - โšก **Immediate AR Detection**: Optimized "warm-up" period (15 frames) with relaxed inlier thresholds (6 pts) for instant tracking lock.
46
- - ๐Ÿ“ฆ **Framework Agnostic**: Includes wrappers for **React**, **A-Frame**, **Three.js**, and a raw **Controller**.
47
- - ๐Ÿ“‰ **Ultra-Compact Files**: Output `.taar` files are now **~100KB** (vs ~380KB+ previously).
46
+ <div align="center">
47
+ <img src="./docs/images/features-grid.png" alt="TapTapp AR Key Features" width="600"/>
48
+ </div>
49
+
50
+ <br/>
51
+
52
+ | Feature | Description |
53
+ |---------|-------------|
54
+ | ๐ŸŽญ **Non-Rigid Tracking** | Curved & deformable surfaces with Delaunay Meshes |
55
+ | ๐Ÿš€ **Nanite-style Features** | Single-pass multi-octave detection |
56
+ | โšก **Zero Dependencies** | No TensorFlow.js - Pure JavaScript |
57
+ | ๐Ÿงฌ **Neural Encoding** | Fourier positional encoding (GPT-style) |
58
+ | ๐Ÿงต **HD Precision** | 1280x960 default resolution |
59
+ | โšก **JIT Compilation** | Pass an image URL, track instantly |
60
+ | ๐Ÿ“ **20% - 1000% Scale** | Extreme scale range from a single keyframe |
61
+ | ๐Ÿ“ฆ **~100KB Output** | Ultra-compact `.taar` files |
48
62
 
49
63
  ---
50
64
 
@@ -58,6 +72,12 @@ npm install @srsergio/taptapp-ar
58
72
 
59
73
  ## ๐Ÿ“Š Industry-Leading Benchmarks (v7 Moonshot)
60
74
 
75
+ <div align="center">
76
+ <img src="./docs/images/performance-chart.png" alt="Performance Comparison" width="500"/>
77
+ </div>
78
+
79
+ <br/>
80
+
61
81
  | Metric | Official MindAR | TapTapp AR V11 | Improvement |
62
82
  | :--- | :--- | :--- | :--- |
63
83
  | **Compilation Time** | ~23.50s | **~1.69s (HD)** | ๐Ÿš€ **~14x Faster** |
@@ -130,6 +150,12 @@ const tracker = await startTracking({
130
150
 
131
151
  ## ๐ŸŽฅ Runtime Usage (AR Tracking)
132
152
 
153
+ <div align="center">
154
+ <img src="./docs/images/ar-tracking-demo.png" alt="AR Tracking Pipeline" width="700"/>
155
+ </div>
156
+
157
+ <br/>
158
+
133
159
  ### 1. The Easy Way: React Component โš›๏ธ
134
160
 
135
161
  The simplest, zero-config way to add AR to your app:
@@ -243,7 +269,7 @@ The `onUpdate` callback provides a rich data object:
243
269
  - `worldMatrix`: 4x4 matrix for WebGL/Three.js integration.
244
270
  - `targetDimensions`: `[width, height]` of the source target.
245
271
 
246
- ### 3. Advanced Integration (Three.js / A-Frame)
272
+ ### 5. Advanced Integration (Three.js / A-Frame)
247
273
 
248
274
  We still provide wrappers for 3D engines if you need to render complex 3D models instead of DOM overlays.
249
275
 
@@ -256,6 +282,13 @@ import { TaarThree } from '@srsergio/taptapp-ar';
256
282
  ---
257
283
 
258
284
  ## ๐Ÿ—๏ธ Protocol V11 (Nanite Virtualized Format)
285
+
286
+ <div align="center">
287
+ <img src="./docs/images/architecture-flow.png" alt="Architecture Pipeline" width="700"/>
288
+ </div>
289
+
290
+ <br/>
291
+
259
292
  TapTapp AR uses a proprietary **Nanite-style Vision Codec** that is significantly more efficient than standard AR formats.
260
293
 
261
294
  - **Virtualized Multi-Octave Features**: Instead of storing redundant images for each scale, V11 stores a single high-res keyframe with features stratified across 6 octaves.
@@ -270,7 +303,13 @@ TapTapp AR uses a proprietary **Nanite-style Vision Codec** that is significantl
270
303
 
271
304
  ---
272
305
 
273
- ## ๏ฟฝ Visual Search & Embeddings (NEW!) ๐Ÿš€
306
+ ## ๐Ÿ” Visual Search & Embeddings (NEW!) ๐Ÿš€
307
+
308
+ <div align="center">
309
+ <img src="./docs/images/visual-search.png" alt="Visual Search & Embeddings" width="600"/>
310
+ </div>
311
+
312
+ <br/>
274
313
 
275
314
  TapTapp AR now includes a state-of-the-art **Image Embedding** system based on Hyperdimensional Computing (HDC). This allows you to convert any image into a tiny mathematical fingerprint (vector) for ultra-fast visual search, deduplication, and clustering.
276
315
 
@@ -316,7 +355,7 @@ await vectorDB.insert({
316
355
 
317
356
  ---
318
357
 
319
- ## ๏ฟฝ๐Ÿ“„ License & Credits
358
+ ## ๐Ÿ“„ License & Credits
320
359
 
321
360
  This project is licensed under the **Fair Source License v0.9**.
322
361
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@srsergio/taptapp-ar",
3
- "version": "1.1.7",
3
+ "version": "1.1.9",
4
4
  "description": "Ultra-fast Augmented Reality (AR) SDK for Node.js and Browser. Image tracking with 100% pure JavaScript, zero-dependencies, and high-performance compilation.",
5
5
  "keywords": [
6
6
  "augmented reality",