@uptimizr/unreal 0.2.1 → 0.2.3
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.
- package/AGENTS.md +137 -0
- package/README.md +8 -3
- package/dist/uptimizr-unreal.global.js +7 -7
- package/dist/uptimizr-unreal.js +7 -7
- package/llms.txt +31 -0
- package/package.json +7 -5
package/llms.txt
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# @uptimizr/unreal
|
|
2
|
+
|
|
3
|
+
> The Unreal Engine (web export) connector for Uptimizr (ADR 0045). Built on
|
|
4
|
+
> `@uptimizr/web-export`: a JS-only tier captures pointer heatmaps / FPS / errors with no engine
|
|
5
|
+
> code, and a copy-in Emscripten shim pushes camera pose, picks and perf over the versioned
|
|
6
|
+
> bridge. Unreal's left-handed, z-up, centimeter frame is rebased and rescaled in TypeScript.
|
|
7
|
+
> Bridged tier is best-effort — there is no official Epic web target.
|
|
8
|
+
|
|
9
|
+
## Docs
|
|
10
|
+
|
|
11
|
+
- [Package reference](./README.md): the two tiers, `trackUnreal`, the best-effort caveat.
|
|
12
|
+
- [Agent guide](./AGENTS.md): rules, the engine-side vs web-side split, export caveats.
|
|
13
|
+
- [Engine-side bridge](./bridge/README.md): the copy-in `Uptimizr.h`/`Uptimizr.cpp`, viable web targets, the JS API.
|
|
14
|
+
- [Unreal guide](https://uptimizr.com/docs/connectors/unreal/): the docs-site walkthrough.
|
|
15
|
+
- [Shared foundation](../web-export/README.md): `@uptimizr/web-export`, the bridge contract and the JS-only tier.
|
|
16
|
+
- [Integration & API reference](https://github.com/RaananW/Uptimizr/blob/main/docs/integration.md): track and query the data (see "Web-export engines").
|
|
17
|
+
- [Architecture Decision Records](https://github.com/RaananW/Uptimizr/tree/main/docs/adr): privacy model (0003), coordinate frame & connector provenance (0018), web-export engine connectors (0045).
|
|
18
|
+
|
|
19
|
+
## Key exports
|
|
20
|
+
|
|
21
|
+
- `trackUnreal(options)` — one-call integration; returns `{ client, bridge }`.
|
|
22
|
+
- `unrealCollector(options)` — the collector for manual composition (`client.use(...)`).
|
|
23
|
+
- `UNREAL_FRAME` — `{ handedness: "left", upAxis: "z", unitScale: 100 }` (z-up, centimeters).
|
|
24
|
+
- `UNREAL_CONNECTOR_NAME` — `"unreal"`, the connector provenance / collector name.
|
|
25
|
+
- Types: `TrackUnrealOptions`, `UnrealCollectorOptions`, `EngineBridge`.
|
|
26
|
+
|
|
27
|
+
## Engine-side copy-in assets
|
|
28
|
+
|
|
29
|
+
- `bridge/Uptimizr.h` + `bridge/Uptimizr.cpp` — copy into `Source/<Module>/` of your web target;
|
|
30
|
+
`UptimizrTelemetry().Initialize()` / `.Tick(World, DeltaSeconds)` / `.TraceAndReportPick(World)`.
|
|
31
|
+
No-ops off Emscripten.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uptimizr/unreal",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"description": "Unreal Engine (web export) connector for Uptimizr — best-effort, pending a viable WASM/HTML5 target. JS-only pointer/perf capture plus a bridged camera-pose / world-space tier via a thin engine-side shim.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"uptimizr",
|
|
@@ -38,12 +38,14 @@
|
|
|
38
38
|
"dist",
|
|
39
39
|
"bridge",
|
|
40
40
|
"README.md",
|
|
41
|
-
"LICENSE"
|
|
41
|
+
"LICENSE",
|
|
42
|
+
"AGENTS.md",
|
|
43
|
+
"llms.txt"
|
|
42
44
|
],
|
|
43
45
|
"dependencies": {
|
|
44
|
-
"@uptimizr/
|
|
45
|
-
"@uptimizr/sdk-core": "1.0
|
|
46
|
-
"@uptimizr/
|
|
46
|
+
"@uptimizr/web-export": "0.2.3",
|
|
47
|
+
"@uptimizr/sdk-core": "1.1.0",
|
|
48
|
+
"@uptimizr/schema": "1.1.0"
|
|
47
49
|
},
|
|
48
50
|
"devDependencies": {
|
|
49
51
|
"esbuild": "^0.28.2",
|