dredless 0.2.1 → 0.3.0
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/README.md +19 -2
- package/dist/browser/dredless.global.js +12047 -0
- package/dist/browser/dredless.global.js.map +7 -0
- package/package.json +9 -4
- package/src/browser-global.js +3 -0
package/README.md
CHANGED
|
@@ -2,9 +2,26 @@
|
|
|
2
2
|
|
|
3
3
|
A headless pure Javascript implementation (with type annotations) of `drednot.io`'s client protocol.
|
|
4
4
|
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
### Node
|
|
8
|
+
```sh
|
|
9
|
+
npm install dredless
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
### Browser
|
|
13
|
+
Use a bundler, or load the browser bundle directly from a CDN:
|
|
14
|
+
|
|
15
|
+
```html
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/dredless/dist/browser/dredless.global.js"></script>
|
|
17
|
+
<script>
|
|
18
|
+
const session = await Dredless.createAnonSession();
|
|
19
|
+
</script>
|
|
20
|
+
```
|
|
21
|
+
|
|
5
22
|
## Quick Start
|
|
6
23
|
|
|
7
|
-
Node (multi-session) usage:
|
|
24
|
+
### Node (multi-session) usage:
|
|
8
25
|
|
|
9
26
|
```js
|
|
10
27
|
import Dredless, {EquipmentSlot, SignDisplayMode} from "dredless/node";
|
|
@@ -28,7 +45,7 @@ client.on("inventory", () => console.log(client.inventory.hotbarSlots().map((slo
|
|
|
28
45
|
client.on("model", ({ world }) => console.log(world.model.transforms()));
|
|
29
46
|
```
|
|
30
47
|
|
|
31
|
-
Browser (ambient-session) usage:
|
|
48
|
+
### Browser (ambient-session) usage:
|
|
32
49
|
|
|
33
50
|
```js
|
|
34
51
|
import Dredless from "dredless/browser";
|