@realsee/equirect-toolbox 1.0.1 → 1.0.2

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.
Files changed (2) hide show
  1. package/README.md +30 -0
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -18,6 +18,36 @@ Node.js command-line tools for working with equirectangular panoramas. The packa
18
18
 
19
19
  Install the package in a project:
20
20
 
21
+ ### X Server and Xvfb
22
+
23
+ On Linux servers, containers, and CI runners without a display server, run the rendering command through [Xvfb](https://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml), a virtual X server:
24
+
25
+ ```bash
26
+ sudo apt-get update
27
+ sudo apt-get install -y xvfb
28
+ ```
29
+
30
+ Use `xvfb-run` to provide a temporary display for the CLI. The `-a` option selects an available display number automatically:
31
+
32
+ ```bash
33
+ xvfb-run -a \
34
+ --server-args="-screen 0 1920x1080x24" \
35
+ equirect-toolbox rectlinear \
36
+ --input equirect.jpg \
37
+ --output perspective.jpg \
38
+ --config rectlinear-matrix.json
39
+ ```
40
+
41
+ The same wrapper can be used with `npx` and the cube conversion commands:
42
+
43
+ ```bash
44
+ xvfb-run -a npx equirect-toolbox equirect2cube \
45
+ --input equirect.jpg \
46
+ --output cube.json
47
+ ```
48
+
49
+ On macOS, `xvfb-run` is generally not required for local execution. If a headless environment reports that no display is available, install Xvfb through the operating system image and run the command with `xvfb-run` as shown above.
50
+
21
51
  ```bash
22
52
  npm install @realsee/equirect-toolbox
23
53
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@realsee/equirect-toolbox",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Node.js CLI tools for rectlinear screenshots and equirectangular-to-cubemap conversion.",
5
5
  "keywords": [
6
6
  "cli",
@@ -52,15 +52,15 @@
52
52
  "pack:check": "npm pack --dry-run"
53
53
  },
54
54
  "dependencies": {
55
- "@napi-rs/canvas": "^0.1.78",
56
- "ajv": "8.17.1",
55
+ "@napi-rs/canvas": "^1.0.8",
56
+ "ajv": "^8.17.1",
57
57
  "commander": "^15.0.0",
58
58
  "gl": "^8.1.6",
59
- "three": "0.149.0"
59
+ "three": "^0.149.0"
60
60
  },
61
61
  "devDependencies": {
62
62
  "@types/node": "^22.20.1",
63
- "@types/three": "0.149.0",
63
+ "@types/three": "^0.149.0",
64
64
  "oxfmt": "^0.64.0",
65
65
  "oxlint": "^1.79.0",
66
66
  "tsx": "^4.19.0",