Skip to content

Commit 0327587

Browse files
nickw1nickw1
committed
0.1.0 release
1 parent 37de0fe commit 0327587

51 files changed

Lines changed: 7598 additions & 9490 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Updates
22

3+
## `0.1.0` (2025-08-23).
4+
5+
With significant improvements particularly on the iOS side, it's been decided to move up to an `0.1.0` release. Note that there are a few **breaking changes** with 0.1.0, particularly with initialising the `Webcam` and the `DeviceOrientationControls`. Please see the examples and the tutorial.
6+
7+
- Many iOS enhancements, thanks to [Darian Elias Weiß](https://github.com/darianwwu) through [PR #16](https://github.com/AR-js-org/locar.js/pull/16) which provides a range of enhancements providing fixes for sensor handling on iOS and consistency between iOS and Android.
8+
9+
- Improved event handling system giving developers more flexibility in error handling, fixing [issue #10](https://github.com/AR-js-org/locar.js/issues/10).
10+
11+
## Older updates
12+
313
- `0.0.12` (2025-05-25) - `DeviceOrientationControls` now takes `options` object which allows the specification of the `smoothingFactor`, like original AR.js.
414

515
- `0.0.11` (2025-04-19) - separated out A-Frame API into own package `locar-aframe` for greater modularity.

‎README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Location-based AR from AR.js.
44

5-
**This is the `PR16` branch of LocAR.js, incorporating the improved event-handling system in issue #10 and pull request #16. It is currently untested on iOS devices. This distribution is not available on `npm`; you have to build it yourself (version `0.0.13-pre3`; use the tarball). If you want to work with A-Frame you also need to build the matching [locar-aframe.js](https://github.com/AR-js-org/locar-aframe.js) distribution, again the `PR16` branch, version `0.0.4-pre2` and maybe modify the path to `locar-aframe.js` in the examples `package.json`.**
6-
75
## What is this?
86

97
LocAR.js is an AR.js project to develop a library focused specifically on location-based augmented reality in the browser. Currently it consists of the location-based three.js code from [the main AR.js repository](https://github.com/AR-js-org/AR.js), with some minor changes to make it compatible with latest versions (0.175.0 at time of writing) of three.js.
@@ -24,7 +22,9 @@ Some of these issues, such as incorrect North on some devices, may well be to do
2422

2523
## Cross-platform Compatibility
2624

27-
Chrome on Android is recommended. It may also work on Chrome in iOS; please file an issue if not. It will not work on Safari on iOS, due to permissions issues - **though pull requests are welcome to fix this**. Firefox unfortunately does not appear to fully implement the Device Orientation API so is unlikely to work
25+
It should now work on Chrome (and possibly Safari) on iOS as well as Android, due to a number of recent iOS fixes by project contributors.
26+
27+
Firefox unfortunately does not appear to fully implement the Device Orientation API so is unlikely to work.
2828

2929
## Using the library
3030

@@ -42,7 +42,7 @@ import * as LocAR from 'locar';
4242
as long as you include `locar` as a dependency, e.g. in your `package.json`:
4343
```
4444
"dependencies": {
45-
"locar" : "^0.0.11",
45+
"locar" : "^0.1.0",
4646
"three" : "^0.175.0"
4747
}
4848
```
@@ -57,6 +57,10 @@ Please see [here](https://ar-js-org.github.io/locar.js/api) for full API documen
5757

5858
Please see [here](https://github.com/AR-js-org/locar.js/blob/master/docs/tutorial/index.md) for a tutorial introducing LocAR.js.
5959

60+
## Contributors
61+
62+
Many thanks to all contributors to the project, in particular [Darian Elias Weiß](https://github.com/darianwwu) and [Kazuhiro Matsuyama](https://github.com/ma2yama) for providing extremely valuable iOS fixes and enhancements.
63+
6064
## Disclaimer
6165

6266
This is an open-source project licensed under the [MIT License](LICENSE) and thus comes with no warranty. Also it is a volunteer-led project; work on the project by AR.js maintainers or any other contributor will be undertaken *time-permitting* only. For this reason we welcome contributors! The more people working on the project, the more likely it is that it will become full-featured and issues will be resolved.

‎docs/01-helloworld/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
}
1010
</style>
1111
<title>LocAR.js example 1</title>
12-
<script type="module" crossorigin src="/locar.js/assets/01-helloworld-Cvb5d5tt.js"></script>
12+
<script type="module" crossorigin src="/locar.js/assets/01-helloworld-v3TnSEvm.js"></script>
1313
<link rel="modulepreload" crossorigin href="/locar.js/assets/modulepreload-polyfill-B5Qt9EMX.js">
14-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-Cq9R6IxD.js">
14+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-D93U996S.js">
1515
</head>
1616
<body>
1717
</body>

‎docs/02-gps-and-sensors/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1, minimum-scale=1, maximum-scale=1" />
55
<title>LocAR.js example 2</title>
6-
<script type="module" crossorigin src="/locar.js/assets/02-gps-and-sensors-Bk21rrRU.js"></script>
6+
<script type="module" crossorigin src="/locar.js/assets/02-gps-and-sensors-D1ydpQyk.js"></script>
77
<link rel="modulepreload" crossorigin href="/locar.js/assets/modulepreload-polyfill-B5Qt9EMX.js">
8-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-Cq9R6IxD.js">
8+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-D93U996S.js">
99
<link rel="stylesheet" crossorigin href="/locar.js/assets/style-D1ozsMkJ.css">
1010
</head>
1111
<body>

‎docs/03-api-communication/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<head>
44
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1, minimum-scale=1, maximum-scale=1" />
55
<title>LocAR.js example 3</title>
6-
<script type="module" crossorigin src="/locar.js/assets/03-api-communication-kSvoNDe_.js"></script>
6+
<script type="module" crossorigin src="/locar.js/assets/03-api-communication-BC8P8qyf.js"></script>
77
<link rel="modulepreload" crossorigin href="/locar.js/assets/modulepreload-polyfill-B5Qt9EMX.js">
8-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-Cq9R6IxD.js">
8+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-D93U996S.js">
99
<link rel="stylesheet" crossorigin href="/locar.js/assets/style-D1ozsMkJ.css">
1010
</head>
1111
<body>

‎docs/04-aframe/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<html>
33
<head>
44
<script type="module" crossorigin src="/locar.js/assets/modulepreload-polyfill-B5Qt9EMX.js"></script>
5-
<script type="module" crossorigin src="/locar.js/assets/locar.es-Cq9R6IxD.js"></script>
6-
<script type="module" crossorigin src="/locar.js/assets/locar-aframe.es-DZQDRjuf.js"></script>
5+
<script type="module" crossorigin src="/locar.js/assets/locar.es-D93U996S.js"></script>
6+
<script type="module" crossorigin src="/locar.js/assets/locar-aframe.es-B0MDZylI.js"></script>
77
</head>
88
<body>
99
<main>

‎docs/05-aframe-js/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE html>
22
<html>
33
<head>
4-
<script type="module" crossorigin src="/locar.js/assets/05-aframe-js-BJId3OIY.js"></script>
4+
<script type="module" crossorigin src="/locar.js/assets/05-aframe-js-EHg127KA.js"></script>
55
<link rel="modulepreload" crossorigin href="/locar.js/assets/modulepreload-polyfill-B5Qt9EMX.js">
6-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-Cq9R6IxD.js">
7-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar-aframe.es-DZQDRjuf.js">
6+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-D93U996S.js">
7+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar-aframe.es-B0MDZylI.js">
88
<link rel="stylesheet" crossorigin href="/locar.js/assets/style-D1ozsMkJ.css">
99
</head>
1010
<body>

‎docs/06-aframe-api-comm/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE html>
22
<html>
33
<head>
4-
<script type="module" crossorigin src="/locar.js/assets/06-aframe-api-comm-UeQ7teIa.js"></script>
4+
<script type="module" crossorigin src="/locar.js/assets/06-aframe-api-comm-DEEPs2U0.js"></script>
55
<link rel="modulepreload" crossorigin href="/locar.js/assets/modulepreload-polyfill-B5Qt9EMX.js">
6-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-Cq9R6IxD.js">
7-
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar-aframe.es-DZQDRjuf.js">
6+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar.es-D93U996S.js">
7+
<link rel="modulepreload" crossorigin href="/locar.js/assets/locar-aframe.es-B0MDZylI.js">
88
<link rel="stylesheet" crossorigin href="/locar.js/assets/style-D1ozsMkJ.css">
99
</head>
1010
<body>

‎docs/api/ClickHandler.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -398,13 +398,13 @@ <h5>Returns:</h5>
398398
</div>
399399

400400
<nav>
401-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ClickHandler.html">ClickHandler</a></li><li><a href="DeviceOrientationControls.html">DeviceOrientationControls</a></li><li><a href="LocationBased.html">LocationBased</a></li><li><a href="SphMercProjection.html">SphMercProjection</a></li><li><a href="Webcam.html">Webcam</a></li></ul><h3>Events</h3><ul><li><a href="LocationBased.html#event:gpserror">gpserror</a></li><li><a href="LocationBased.html#event:gpsupdate">gpsupdate</a></li></ul>
401+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ClickHandler.html">ClickHandler</a></li><li><a href="DeviceOrientationControls.html">DeviceOrientationControls</a></li><li><a href="LocationBased.html">LocationBased</a></li><li><a href="SphMercProjection.html">SphMercProjection</a></li><li><a href="Webcam.html">Webcam</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Events</h3><ul><li><a href="DeviceOrientationControls.html#event:deviceorientationerror">deviceorientationerror</a></li><li><a href="DeviceOrientationControls.html#event:deviceorientationgranted">deviceorientationgranted</a></li><li><a href="LocationBased.html#event:gpserror">gpserror</a></li><li><a href="LocationBased.html#event:gpsupdate">gpsupdate</a></li><li><a href="Webcam.html#event:webcamerror">webcamerror</a></li><li><a href="Webcam.html#event:webcamstarted">webcamstarted</a></li></ul><h3>Global</h3><ul><li><a href="global.html#emit">emit</a></li><li><a href="global.html#on">on</a></li></ul>
402402
</nav>
403403

404404
<br class="clear">
405405

406406
<footer>
407-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Jul 16 2025 11:48:20 GMT+0100 (British Summer Time)
407+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Aug 23 2025 15:05:39 GMT+0100 (British Summer Time)
408408
</footer>
409409

410410
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)