Skip to content

Commit

Permalink
Update version in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentfretin committed Dec 17, 2023
1 parent 8ba5969 commit 9cfa6aa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -72,10 +72,10 @@ Basic Example
<html>
<head>
<title>My Networked-Aframe Scene</title>
<script src="https://aframe.io/releases/1.4.2/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.5.0/aframe.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/2.5.0/socket.io.slim.js"></script>
<script src="/easyrtc/easyrtc.js"></script>
<script src="https://unpkg.com/networked-aframe@^0.11.0/dist/networked-aframe.min.js"></script>
<script src="https://unpkg.com/networked-aframe@^0.12.0/dist/networked-aframe.min.js"></script>
</head>
<body>
<a-scene networked-scene>
Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started-local.md
Expand Up @@ -36,7 +36,7 @@ Now let's setup the required dependencies. Create a file called `package.json` a
},
"author": "YOUR_NAME",
"dependencies": {
"networked-aframe": "^0.11.0"
"networked-aframe": "^0.12.0"
}
}
```
Expand Down Expand Up @@ -110,10 +110,10 @@ Here's the template we'll start with:
```html
<html>
<head>
<script src="https://aframe.io/releases/1.4.1/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.5.0/aframe.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/2.5.0/socket.io.slim.js"></script>
<script src="/easyrtc/easyrtc.js"></script>
<script src="https://unpkg.com/networked-aframe@^0.11.0/dist/networked-aframe.min.js"></script>
<script src="https://unpkg.com/networked-aframe@^0.12.0/dist/networked-aframe.min.js"></script>
</head>
<body>
<a-scene></a-scene>
Expand All @@ -122,8 +122,8 @@ Here's the template we'll start with:
```

Please don't use `https://unpkg.com/networked-aframe/dist/networked-aframe.min.js` for production, this will download the latest major release that may contain breaking changes.
It's ok for a testing environment to specify "@^0.11.0" in the url so it downloads the latest minor version that shouldn't have breaking changes.
For production you want to pin to a specific version like `https://unpkg.com/networked-aframe@0.11.0/dist/networked-aframe.min.js`.
It's ok for a testing environment to specify "@^0.12.0" in the url so it downloads the latest minor version that shouldn't have breaking changes.
For production you want to pin to a specific version like `https://unpkg.com/networked-aframe@0.12.0/dist/networked-aframe.min.js`.

If you want to use a more recent build from github master that is not released yet, you can use:

Expand Down Expand Up @@ -313,7 +313,7 @@ I'm planning on writing a follow-up tutorial to this one that will explain how t

### Syncing Custom Components

Components are synchronized by comparing the state of a component [provided by A-Frame](https://aframe.io/docs/0.7.0/core/entity.html#getattribute-componentname) on a network 'tick'. How quickly this tick happens can be defined in the [NAF Options](https://github.com/networked-aframe/networked-aframe#options), but the default is 15 times per second. On each tick the state is checked against its previous value, and if it changed it's sent over the network to the other users.
Components are synchronized by comparing the state of a component [provided by A-Frame](https://aframe.io/docs/1.5.0/core/entity.html#getattribute-componentname) on a network 'tick'. How quickly this tick happens can be defined in the [NAF Options](https://github.com/networked-aframe/networked-aframe#options), but the default is 15 times per second. On each tick the state is checked against its previous value, and if it changed it's sent over the network to the other users.

So how do we choose which components to sync? By default, the `position` and `rotation` components are synced but NAF lets you specify any component that you wish to sync, included child components found in the deep depths of your templates.

Expand Down
2 changes: 1 addition & 1 deletion examples/shooter-ar.html
Expand Up @@ -4,7 +4,7 @@
<title>Shooter AR Example — Networked-Aframe</title>
<meta name="description" content="Shooter AR Example — Networked-Aframe" />

<script src="https://aframe.io/releases/1.4.2/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.5.0/aframe.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/2.5.0/socket.io.slim.js"></script>
<script src="/easyrtc/easyrtc.js"></script>
<script src="/dist/networked-aframe.js"></script>
Expand Down

0 comments on commit 9cfa6aa

Please sign in to comment.