Skip to content

Commit d4bddd7

Browse files
typofix
1 parent 46a6127 commit d4bddd7

File tree

2 files changed

+29
-24
lines changed

2 files changed

+29
-24
lines changed

README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -93,25 +93,26 @@ a Linux ISO image (via WASM).
9393

9494
> depends on [AFRAME.utils.require](com/require.js)
9595
96-
| property | type | default | info |
97-
|------------------|-----------|------------------------|------|
98-
| `iso` | `string` | https`//forgejo.isvery.ninja/assets/xrsh-buildroot/main/xrsh.iso" | |
99-
| `overlayfs` | `string` | *WORK-IN-PROGRESS* | |
100-
| `width` | `number` | 800 ||
101-
| `height` | `number` | 600 ||
102-
| `depth` | `number` | 0.03 ||
103-
| `lineHeight` | `number` | 18 ||
104-
| `bootmenu` | `boolean` | true | give user choice [or boot straight into ISO ] |
105-
| `padding` | `number`` | 18 | |
106-
| `maximized` | `boolean` | false | |
107-
| `minimized` | `boolean` | false | |
108-
| `muteUntilPrompt`| `boolean` | true | mute stdout until a prompt is detected in ISO |
109-
| `HUD` | `boolean` | false | link to camera movement |
110-
| `transparent` | `boolean` | false | heavy, needs good gpu |
111-
| `memory` | `number` | 60 | VM memory (in MB) [NOTE` quest or smartphone webworker might crash > 40mb ] |
112-
| `bufferLatency` | `number` | 1 | in ms` bufferlatency from webworker to term (batch-update every char to texture) |
113-
| `debug` | `boolean` | false | |
114-
| `emulator` | `string` | fbterm | terminal emulator |
96+
| property | type | default | info |
97+
|-------------------|-----------|------------------------|------|
98+
| `iso` | `string` | https`//forgejo.isvery.ninja/assets/xrsh-buildroot/main/xrsh.iso" | |
99+
| `overlayfs` | `string` | '' | zip URL/file to autoextract on top of filesystem |
100+
| `width` | `number` | 800 ||
101+
| `height` | `number` | 600 ||
102+
| `depth` | `number` | 0.03 ||
103+
| `lineHeight` | `number` | 18 ||
104+
| `bootMenu` | `string` | "" | character to auto-enter in bootMenu |
105+
| `bootMenuURL` | `string` | "" | character to auto-enter in bootMenu when URL has fragment (#foo.zip e.g.) |
106+
| `padding` | `number` | 18 | |
107+
| `maximized` | `boolean` | false | |
108+
| `minimized` | `boolean` | false | |
109+
| `muteUntilPrompt` | `boolean` | true | mute stdout until a prompt is detected in ISO |
110+
| `HUD` | `boolean` | false | link to camera movement |
111+
| `transparent` | `boolean` | false | heavy, needs good gpu |
112+
| `memory` | `number` | 60 | VM memory (in MB) [NOTE` quest or smartphone webworker might crash > 40mb ] |
113+
| `bufferLatency` | `number` | 1 | in ms` bufferlatency from webworker to term (batch-update every char to texture) |
114+
| `debug` | `boolean` | false | |
115+
| `emulator` | `string` | fbterm | terminal emulator |
115116

116117
> for more info see [xrsh.isvery.ninja](https://xrsh.isvery.ninja)
117118
@@ -149,14 +150,18 @@ NOTE: For convenience reasons, events are forwarded between com/isoterminal.js,
149150

150151
## [launcher](com/launcher.js)
151152

152-
displays app (icons) for enduser to launch
153+
displays app (icons) in 2D and 3D handmenu (enduser can launch desktop-like 'apps')
153154

154-
```javascript
155-
<a-scene launcher/>
155+
```html
156+
<a-entity launcher>
157+
<a-entity launch="component: helloworld; foo: bar"><a-entity>
158+
</a-entity>
159+
156160
```
157161

158162
| property | type | example |
159163
|--------------|--------------------|----------------------------------------------------------------------------------------|
164+
| `attach` | `selector` | hand or object to attach menu to |
160165
| `registries` | `array` of strings | `<a-entity launcher="registers: https://foo.com/index.json, ./index.json"/>` |
161166

162167
| event | target | info |

com/isoterminal.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
* | `depth` | `number` | 0.03 ||
2121
* | `lineHeight` | `number` | 18 ||
2222
* | `bootMenu` | `string` | "" | character to auto-enter in bootMenu |
23-
* | `bootMenuURL` | `string` | "" | character to auto-enter in bootmeun when URL has fragment (#foo.zip e.g.) |
24-
* | `padding` | `number`` | 18 | |
23+
* | `bootMenuURL` | `string` | "" | character to auto-enter in bootMenu when URL has fragment (#foo.zip e.g.) |
24+
* | `padding` | `number` | 18 | |
2525
* | `maximized` | `boolean` | false | |
2626
* | `minimized` | `boolean` | false | |
2727
* | `muteUntilPrompt` | `boolean` | true | mute stdout until a prompt is detected in ISO |

0 commit comments

Comments
 (0)