@hcikn/colibri 2.0.0 → 2.0.1
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 +4 -0
- package/package.json +105 -100
package/README.md
CHANGED
|
@@ -76,6 +76,10 @@ exchange data, start the same sample in a second terminal, or run it next to a U
|
|
|
76
76
|
| [remote-logging](samples/remote-logging.ts) | Sending the console log to the server |
|
|
77
77
|
| [rest-api](samples/rest-api.ts) | Saving and loading values in the data store |
|
|
78
78
|
| [sync-transform](samples/sync-transform.ts) | Showing and moving Unity's `SyncTransform` objects |
|
|
79
|
+
| [webxr](samples/webxr/) | The same in WebXR with three.js, in the browser |
|
|
80
|
+
|
|
81
|
+
`npm run samples/webxr` serves the WebXR sample at `https://localhost:5173`, also to headsets in the same network.
|
|
82
|
+
How to open it and choose the server: [SyncTransform in WebXR](https://colibri.hci.uni-konstanz.de/web/synctransform#in-webxr).
|
|
79
83
|
|
|
80
84
|
## Usage
|
|
81
85
|
|
package/package.json
CHANGED
|
@@ -1,100 +1,105 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@hcikn/colibri",
|
|
3
|
-
"version": "2.0.
|
|
4
|
-
"description": "Communication Library for Research Prototyping - Allows object synchronization, networking, and voice chat with little to no code required",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"main": "./dist/index.cjs",
|
|
7
|
-
"module": "./dist/index.js",
|
|
8
|
-
"types": "./dist/index.d.ts",
|
|
9
|
-
"exports": {
|
|
10
|
-
".": {
|
|
11
|
-
"import": {
|
|
12
|
-
"types": "./dist/index.d.ts",
|
|
13
|
-
"default": "./dist/index.js"
|
|
14
|
-
},
|
|
15
|
-
"require": {
|
|
16
|
-
"types": "./dist/index.d.cts",
|
|
17
|
-
"default": "./dist/index.cjs"
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
},
|
|
21
|
-
"engines": {
|
|
22
|
-
"node": ">=18"
|
|
23
|
-
},
|
|
24
|
-
"devEngines": {
|
|
25
|
-
"runtime": {
|
|
26
|
-
"name": "node",
|
|
27
|
-
"version": ">=22",
|
|
28
|
-
"onFail": "warn"
|
|
29
|
-
}
|
|
30
|
-
},
|
|
31
|
-
"scripts": {
|
|
32
|
-
"build": "tsup",
|
|
33
|
-
"lint": "eslint .",
|
|
34
|
-
"lint:fix": "eslint . --fix",
|
|
35
|
-
"format": "prettier --write .",
|
|
36
|
-
"format:check": "prettier --check .",
|
|
37
|
-
"prepare": "cd .. && husky colibri-web/.husky",
|
|
38
|
-
"prepublishOnly": "npm run build",
|
|
39
|
-
"release": "npm run build && npm publish --access public",
|
|
40
|
-
"samples/broadcast": "tsx samples/broadcast.ts",
|
|
41
|
-
"samples/model-sync": "tsx samples/model-sync.ts",
|
|
42
|
-
"samples/remote-logging": "tsx samples/remote-logging.ts",
|
|
43
|
-
"samples/rest-api": "tsx samples/rest-api.ts",
|
|
44
|
-
"samples/sync-transform": "tsx samples/sync-transform.ts",
|
|
45
|
-
"samples/verification-peer": "tsx samples/verification-peer.ts",
|
|
46
|
-
"
|
|
47
|
-
"test
|
|
48
|
-
"test:
|
|
49
|
-
"test:
|
|
50
|
-
"test:e2e
|
|
51
|
-
"
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
"
|
|
55
|
-
"
|
|
56
|
-
"
|
|
57
|
-
|
|
58
|
-
"
|
|
59
|
-
"
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
"
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
"@
|
|
77
|
-
"@
|
|
78
|
-
"@types/
|
|
79
|
-
"@
|
|
80
|
-
"
|
|
81
|
-
"
|
|
82
|
-
"
|
|
83
|
-
"eslint
|
|
84
|
-
"
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
"
|
|
89
|
-
"
|
|
90
|
-
"
|
|
91
|
-
"
|
|
92
|
-
"
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
"
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@hcikn/colibri",
|
|
3
|
+
"version": "2.0.1",
|
|
4
|
+
"description": "Communication Library for Research Prototyping - Allows object synchronization, networking, and voice chat with little to no code required",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.cjs",
|
|
7
|
+
"module": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"import": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
},
|
|
15
|
+
"require": {
|
|
16
|
+
"types": "./dist/index.d.cts",
|
|
17
|
+
"default": "./dist/index.cjs"
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"engines": {
|
|
22
|
+
"node": ">=18"
|
|
23
|
+
},
|
|
24
|
+
"devEngines": {
|
|
25
|
+
"runtime": {
|
|
26
|
+
"name": "node",
|
|
27
|
+
"version": ">=22",
|
|
28
|
+
"onFail": "warn"
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"scripts": {
|
|
32
|
+
"build": "tsup",
|
|
33
|
+
"lint": "eslint .",
|
|
34
|
+
"lint:fix": "eslint . --fix",
|
|
35
|
+
"format": "prettier --write .",
|
|
36
|
+
"format:check": "prettier --check .",
|
|
37
|
+
"prepare": "cd .. && husky colibri-web/.husky",
|
|
38
|
+
"prepublishOnly": "npm run build",
|
|
39
|
+
"release": "npm run build && npm publish --access public",
|
|
40
|
+
"samples/broadcast": "tsx samples/broadcast.ts",
|
|
41
|
+
"samples/model-sync": "tsx samples/model-sync.ts",
|
|
42
|
+
"samples/remote-logging": "tsx samples/remote-logging.ts",
|
|
43
|
+
"samples/rest-api": "tsx samples/rest-api.ts",
|
|
44
|
+
"samples/sync-transform": "tsx samples/sync-transform.ts",
|
|
45
|
+
"samples/verification-peer": "tsx samples/verification-peer.ts",
|
|
46
|
+
"samples/webxr": "npm run build && vite --config samples/webxr/vite.config.ts",
|
|
47
|
+
"test": "vitest run",
|
|
48
|
+
"test:watch": "vitest",
|
|
49
|
+
"test:coverage": "vitest run --coverage",
|
|
50
|
+
"test:e2e": "vitest run --config vitest.e2e.config.ts",
|
|
51
|
+
"test:e2e:watch": "vitest --config vitest.e2e.config.ts",
|
|
52
|
+
"typecheck": "tsc --noEmit"
|
|
53
|
+
},
|
|
54
|
+
"author": "HCI Group, University of Konstanz",
|
|
55
|
+
"license": "MIT",
|
|
56
|
+
"homepage": "https://github.com/hcigroupkonstanz/colibri",
|
|
57
|
+
"repository": {
|
|
58
|
+
"type": "git",
|
|
59
|
+
"url": "https://github.com/hcigroupkonstanz/colibri.git",
|
|
60
|
+
"directory": "colibri-web"
|
|
61
|
+
},
|
|
62
|
+
"files": [
|
|
63
|
+
"/dist"
|
|
64
|
+
],
|
|
65
|
+
"publishConfig": {
|
|
66
|
+
"access": "public"
|
|
67
|
+
},
|
|
68
|
+
"peerDependencies": {
|
|
69
|
+
"rxjs": "^7.8.1"
|
|
70
|
+
},
|
|
71
|
+
"dependencies": {
|
|
72
|
+
"socket.io-client": "^4.7.1",
|
|
73
|
+
"ts-custom-error": "^3.3.1"
|
|
74
|
+
},
|
|
75
|
+
"devDependencies": {
|
|
76
|
+
"@eslint/js": "^10.0.1",
|
|
77
|
+
"@swc/core": "^1.3.96",
|
|
78
|
+
"@types/lodash": "^4.14.195",
|
|
79
|
+
"@types/node": "^20.19.39",
|
|
80
|
+
"@types/three": "^0.186.0",
|
|
81
|
+
"@vitejs/plugin-basic-ssl": "^2.3.0",
|
|
82
|
+
"@vitest/coverage-v8": "^3.2.4",
|
|
83
|
+
"eslint": "^10.7.0",
|
|
84
|
+
"eslint-config-prettier": "^10.1.8",
|
|
85
|
+
"eslint-plugin-n": "^18.2.2",
|
|
86
|
+
"eslint-plugin-promise": "^7.3.0",
|
|
87
|
+
"husky": "^9.1.7",
|
|
88
|
+
"lint-staged": "^15.5.2",
|
|
89
|
+
"prettier": "^3.9.6",
|
|
90
|
+
"rxjs": "^7.8.1",
|
|
91
|
+
"three": "^0.186.1",
|
|
92
|
+
"tsup": "^8.5.0",
|
|
93
|
+
"tsx": "^4.21.0",
|
|
94
|
+
"typescript": "^5.1.6",
|
|
95
|
+
"typescript-eslint": "^8.65.0",
|
|
96
|
+
"vite": "^8.3.5",
|
|
97
|
+
"vitest": "^3.2.4"
|
|
98
|
+
},
|
|
99
|
+
"lint-staged": {
|
|
100
|
+
"**/*.{ts,js}": [
|
|
101
|
+
"eslint --fix",
|
|
102
|
+
"prettier --write"
|
|
103
|
+
]
|
|
104
|
+
}
|
|
105
|
+
}
|