@ignifx/editor-host 0.0.0-stage → 0.9.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/LICENSE +201 -0
- package/client.d.ts +21 -0
- package/package.json +80 -3
- package/skills/editor-host/SKILL.md +229 -0
- package/README.md +0 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/client.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The ambient module `@ignifx/editor-host/vite` adds to a project. Reference it once, beside
|
|
3
|
+
* `@ignifx/vite-plugin/client`:
|
|
4
|
+
*
|
|
5
|
+
* ```ts
|
|
6
|
+
* /// <reference types="@ignifx/editor-host/client" />
|
|
7
|
+
* ```
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
declare module "virtual:ignifx/editor" {
|
|
11
|
+
import type { App } from "@ignifx/core";
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Hands the game's app to the ignifx editor's play controls in development: the editor can then
|
|
15
|
+
* play, pause, step and stop it. In a production build this is a no-op.
|
|
16
|
+
*
|
|
17
|
+
* @param app - The running app.
|
|
18
|
+
* @returns A function that detaches the controls.
|
|
19
|
+
*/
|
|
20
|
+
export function attachEditorPlayControls(app: App): () => void;
|
|
21
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,83 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ignifx/editor-host",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.9.0",
|
|
4
|
+
"description": "ignifx editor host: runs a project's own engine inside the ignifx editor's scene view and play view, over a versioned protocol.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"ignifx"
|
|
7
|
+
],
|
|
8
|
+
"homepage": "https://ignifx.com",
|
|
9
|
+
"license": "Apache-2.0",
|
|
10
|
+
"author": "Astrum Forge Studios",
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "git+https://github.com/astrum-forge/ignifx.git",
|
|
14
|
+
"directory": "packages/editor-host"
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"dist",
|
|
18
|
+
"skills",
|
|
19
|
+
"client.d.ts"
|
|
20
|
+
],
|
|
21
|
+
"type": "module",
|
|
22
|
+
"sideEffects": false,
|
|
23
|
+
"exports": {
|
|
24
|
+
".": {
|
|
25
|
+
"types": "./dist/index.d.ts",
|
|
26
|
+
"import": "./dist/index.js"
|
|
27
|
+
},
|
|
28
|
+
"./vite": {
|
|
29
|
+
"types": "./dist/vite.d.ts",
|
|
30
|
+
"import": "./dist/vite.js"
|
|
31
|
+
},
|
|
32
|
+
"./client": {
|
|
33
|
+
"types": "./client.d.ts"
|
|
34
|
+
},
|
|
35
|
+
"./package.json": "./package.json"
|
|
36
|
+
},
|
|
37
|
+
"publishConfig": {
|
|
38
|
+
"access": "public",
|
|
39
|
+
"provenance": false
|
|
40
|
+
},
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"@arethetypeswrong/cli": "^0.18.5",
|
|
43
|
+
"@microsoft/api-extractor": "^7.59.0",
|
|
44
|
+
"@types/node": "^24.13.3",
|
|
45
|
+
"@types/webxr": "^0.5.0",
|
|
46
|
+
"@webgpu/types": "^0.1.72",
|
|
47
|
+
"publint": "^0.3.24",
|
|
48
|
+
"tsdown": "^0.23.0",
|
|
49
|
+
"typedoc": "^0.28.20",
|
|
50
|
+
"typedoc-plugin-markdown": "^4.13.0",
|
|
51
|
+
"typescript-native": "npm:typescript@7.0.2",
|
|
52
|
+
"vite": "^8.2.2",
|
|
53
|
+
"vitest": "^5.0.0",
|
|
54
|
+
"@ignifx/core": "0.9.0",
|
|
55
|
+
"@ignifx/vite-plugin": "0.9.0"
|
|
56
|
+
},
|
|
57
|
+
"peerDependencies": {
|
|
58
|
+
"vite": "^8.2.2",
|
|
59
|
+
"@ignifx/core": "0.9.0",
|
|
60
|
+
"@ignifx/vite-plugin": "0.9.0"
|
|
61
|
+
},
|
|
62
|
+
"peerDependenciesMeta": {
|
|
63
|
+
"@ignifx/vite-plugin": {
|
|
64
|
+
"optional": true
|
|
65
|
+
},
|
|
66
|
+
"vite": {
|
|
67
|
+
"optional": true
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"ignifx": {
|
|
71
|
+
"engine": ">=0.0.0 <1.0.0",
|
|
72
|
+
"skill": "./skills/editor-host/SKILL.md"
|
|
73
|
+
},
|
|
74
|
+
"scripts": {
|
|
75
|
+
"build": "tsdown",
|
|
76
|
+
"typecheck": "tsc --build tsconfig.json tsconfig.test.json",
|
|
77
|
+
"test": "vitest run --project node --project node-isolated --root ../.. packages/editor-host",
|
|
78
|
+
"api-report": "api-extractor run --verbose && api-extractor run --verbose -c api-extractor.vite.json",
|
|
79
|
+
"docs:api": "typedoc && typedoc --options typedoc.vite.json",
|
|
80
|
+
"api-report:update": "api-extractor run --local --verbose && api-extractor run --local --verbose -c api-extractor.vite.json",
|
|
81
|
+
"pack-check": "publint && attw --pack . --profile esm-only"
|
|
82
|
+
}
|
|
6
83
|
}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: editor-host
|
|
3
|
+
description: Connects an ignifx project to the ignifx editor with @ignifx/editor-host: the Vite plugin that serves the editor's scene view from the project's own dev server, the virtual:ignifx/editor play controls a game's main.ts hands its app to, and the host half of the editor protocol (hello/ready, ping, heartbeat) over a MessagePort. Use when wiring a project or template for the editor, when the user mentions @ignifx/editor-host, editorHostPlugin, attachEditorPlayControls, virtual:ignifx/editor, startEditorHost or /__ignifx_editor__/, or when debugging why the editor cannot connect to a view.
|
|
4
|
+
license: Apache-2.0
|
|
5
|
+
metadata:
|
|
6
|
+
ignifx-version: "0.9.0"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# @ignifx/editor-host
|
|
10
|
+
|
|
11
|
+
## What this is / when to use
|
|
12
|
+
|
|
13
|
+
`@ignifx/editor-host` is the part of the ignifx editor that lives **inside a project**. The editor
|
|
14
|
+
never bundles the engine: it starts the project's own Vite dev server and shows two pages from it in
|
|
15
|
+
frames. The **scene view** is `/__ignifx_editor__/`, a page this package's Vite plugin adds; the
|
|
16
|
+
**play view** is the game's own `index.html`. Both use the project's single copy of `@ignifx/core`,
|
|
17
|
+
so the editor always runs exactly the engine version and the scripts the project has.
|
|
18
|
+
|
|
19
|
+
Use it when a project should open in the editor. Game code never calls the host directly: the Vite
|
|
20
|
+
plugin generates the scene view's page, and `main.ts` adds one line for the play view. Do not ship it;
|
|
21
|
+
production builds contain none of it.
|
|
22
|
+
|
|
23
|
+
The package is on the engine's version line (install the same version as `@ignifx/core`), not the
|
|
24
|
+
editor's, even though its name starts with `editor-`.
|
|
25
|
+
|
|
26
|
+
## Environment
|
|
27
|
+
|
|
28
|
+
- Engine: ignifx `0.9.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
|
|
29
|
+
- Peers: `@ignifx/core`; for the `./vite` entry, `@ignifx/vite-plugin` and `vite`.
|
|
30
|
+
- A development dependency of the project, at the same version as its `@ignifx/core`.
|
|
31
|
+
- Nothing happens at import time; the plugin's generated page module is what starts the host.
|
|
32
|
+
|
|
33
|
+
```ts ignore-check
|
|
34
|
+
// vite.config.ts — the editor passes its own origin when it starts the dev server.
|
|
35
|
+
import { ignifx } from "@ignifx/vite-plugin";
|
|
36
|
+
import { editorHostPlugin } from "@ignifx/editor-host/vite";
|
|
37
|
+
import { defineConfig } from "vite";
|
|
38
|
+
|
|
39
|
+
export default defineConfig({
|
|
40
|
+
plugins: [ignifx(), editorHostPlugin({ editorOrigin: process.env.IGNIFX_EDITOR_ORIGIN ?? "ignifx://app" })],
|
|
41
|
+
});
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
| Option | Default | Meaning |
|
|
45
|
+
| --------------------- | ---------------------- | --------------------------------------------------------------------------- |
|
|
46
|
+
| `editorOrigin` | required | The editor's origin; the only one that may frame the scene view or connect |
|
|
47
|
+
| `extensions` | `"/src/extensions.ts"` | Module exporting `extensions()`; the scene view uses `[]` when it is absent |
|
|
48
|
+
| `bootScene` | none | A scene address the scene view loads before it starts |
|
|
49
|
+
| `heartbeatIntervalMs` | `1000` | Milliseconds between `heartbeat` notifications in both views |
|
|
50
|
+
|
|
51
|
+
Add `/// <reference types="@ignifx/editor-host/client" />` beside `@ignifx/vite-plugin/client` so
|
|
52
|
+
`virtual:ignifx/editor` is typed.
|
|
53
|
+
|
|
54
|
+
## Mental model
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
editor window (ignifx://app)
|
|
58
|
+
├── <iframe> scene view http://127.0.0.1:<port>/__ignifx_editor__/
|
|
59
|
+
│ generated module → startEditorHost({ extensions(), scripts, settings, manifest })
|
|
60
|
+
│ owns its app, in edit mode; hostKind "scene"
|
|
61
|
+
└── <iframe> play view http://localhost:<port>/ (the game's own index.html)
|
|
62
|
+
main.ts → attachEditorPlayControls(app) (virtual:ignifx/editor; a no-op in builds)
|
|
63
|
+
the game owns its app; hostKind "play"
|
|
64
|
+
|
|
65
|
+
each view ◀── MessagePort ──▶ editor JSON-RPC 2.0, protocol 0.2
|
|
66
|
+
connect (window message, origin-checked) → hello → ready → ping/pong, heartbeat, play/pause/step/stop
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The editor posts `{ type: "ignifx-editor/connect" }` with a fresh `MessagePort` to each view on every
|
|
70
|
+
`load`. A host takes a port only from `editorOrigin`, replaces its old port whenever a new one
|
|
71
|
+
arrives, answers `hello` with `ready` (engine version, protocol, capabilities, host kind), and then
|
|
72
|
+
sends a `heartbeat` notification every second so the editor notices a crashed view.
|
|
73
|
+
|
|
74
|
+
## First app
|
|
75
|
+
|
|
76
|
+
A headless scene-view host and the editor's side of the handshake, in one Node program. An
|
|
77
|
+
`EventTarget` stands in for the frame's `window`.
|
|
78
|
+
|
|
79
|
+
```ts run
|
|
80
|
+
import { EDITOR_CONNECT_MESSAGE_TYPE, PROTOCOL_VERSION, startEditorHost } from "@ignifx/editor-host";
|
|
81
|
+
|
|
82
|
+
const frameWindow = new EventTarget();
|
|
83
|
+
const host = await startEditorHost({ editorOrigin: "ignifx://app", headless: true, messageTarget: frameWindow });
|
|
84
|
+
|
|
85
|
+
// The editor's side: a fresh channel, with one end posted to the view's window.
|
|
86
|
+
const channel = new MessageChannel();
|
|
87
|
+
frameWindow.dispatchEvent(
|
|
88
|
+
new MessageEvent("message", {
|
|
89
|
+
data: { type: EDITOR_CONNECT_MESSAGE_TYPE },
|
|
90
|
+
origin: "ignifx://app",
|
|
91
|
+
ports: [channel.port2],
|
|
92
|
+
}),
|
|
93
|
+
);
|
|
94
|
+
|
|
95
|
+
const ready = await new Promise<unknown>((resolve) => {
|
|
96
|
+
channel.port1.onmessage = (event: MessageEvent): void => {
|
|
97
|
+
resolve(event.data);
|
|
98
|
+
};
|
|
99
|
+
channel.port1.postMessage({
|
|
100
|
+
jsonrpc: "2.0",
|
|
101
|
+
id: 1,
|
|
102
|
+
method: "hello",
|
|
103
|
+
params: { editorVersion: "0.1.0", protocol: PROTOCOL_VERSION },
|
|
104
|
+
});
|
|
105
|
+
});
|
|
106
|
+
console.log(JSON.stringify(ready));
|
|
107
|
+
|
|
108
|
+
channel.port1.close();
|
|
109
|
+
host.dispose();
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Core APIs
|
|
113
|
+
|
|
114
|
+
`skills/ignifx/references/api/editor-host.md` and `editor-host-vite.md` have the generated surface.
|
|
115
|
+
|
|
116
|
+
| Member | What it does |
|
|
117
|
+
| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
118
|
+
| `editorHostPlugin(options)` (`/vite`) | The two Vite plugins: the scene view's page (dev only) and `virtual:ignifx/editor` |
|
|
119
|
+
| `attachEditorPlayControls(app)` | From `virtual:ignifx/editor`: hands the game's app to the editor; returns a detach |
|
|
120
|
+
| `startEditorHost(options)` | Starts the scene view's host and its edit-mode app; resolves to a disposable `EditorHost` |
|
|
121
|
+
| `startEditorPlayControls(app, options)` | What `attachEditorPlayControls` calls in development |
|
|
122
|
+
| `EDITOR_CONNECT_MESSAGE_TYPE`, `isEditorConnectMessage` | The window message that carries the port, and its check |
|
|
123
|
+
| `PROTOCOL_VERSION`, `RpcErrorCode`, `isRpcMessage`, `isPlayState` | The protocol 0.2 values and checks, mirrored from `@ignifx/editor-protocol`; before 1.0 the major and minor must both match |
|
|
124
|
+
| `PlayMethod`, `PlayState` | `play`, `pause`, `step`, `stop`, and what each answers |
|
|
125
|
+
| `EditorHostErrorCode` | `IGX-1801` bad origin, `IGX-1802` no window, `IGX-1803` bad option |
|
|
126
|
+
|
|
127
|
+
## Recipes
|
|
128
|
+
|
|
129
|
+
### Hand the game to the play controls
|
|
130
|
+
|
|
131
|
+
```ts ignore-check
|
|
132
|
+
// src/main.ts, after createApp and registerComponents.
|
|
133
|
+
import { attachEditorPlayControls } from "virtual:ignifx/editor";
|
|
134
|
+
import { acceptHotReload } from "virtual:ignifx/scripts";
|
|
135
|
+
|
|
136
|
+
acceptHotReload(app);
|
|
137
|
+
attachEditorPlayControls(app);
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
In `vite build` the import is an empty function, so the same `main.ts` ships with no editor code.
|
|
141
|
+
|
|
142
|
+
### Share the extension list with the scene view
|
|
143
|
+
|
|
144
|
+
```ts
|
|
145
|
+
// src/extensions.ts — main.ts passes `extensions: extensions()` to createApp too.
|
|
146
|
+
import type { Extension } from "@ignifx/core";
|
|
147
|
+
|
|
148
|
+
export function extensions(): Extension[] {
|
|
149
|
+
return [];
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Drive the play view
|
|
154
|
+
|
|
155
|
+
```ts run
|
|
156
|
+
import { createApp } from "@ignifx/core";
|
|
157
|
+
import { EDITOR_CONNECT_MESSAGE_TYPE, PROTOCOL_VERSION, startEditorPlayControls } from "@ignifx/editor-host";
|
|
158
|
+
|
|
159
|
+
const app = await createApp({ headless: true });
|
|
160
|
+
const pageWindow = new EventTarget();
|
|
161
|
+
const controls = startEditorPlayControls(app, { editorOrigin: "ignifx://app", messageTarget: pageWindow });
|
|
162
|
+
|
|
163
|
+
const channel = new MessageChannel();
|
|
164
|
+
pageWindow.dispatchEvent(
|
|
165
|
+
new MessageEvent("message", {
|
|
166
|
+
data: { type: EDITOR_CONNECT_MESSAGE_TYPE },
|
|
167
|
+
origin: "ignifx://app",
|
|
168
|
+
ports: [channel.port2],
|
|
169
|
+
}),
|
|
170
|
+
);
|
|
171
|
+
const answers: unknown[] = [];
|
|
172
|
+
const done = new Promise<void>((resolve) => {
|
|
173
|
+
channel.port1.onmessage = (event: MessageEvent): void => {
|
|
174
|
+
answers.push(event.data);
|
|
175
|
+
if (answers.length === 3) {
|
|
176
|
+
resolve();
|
|
177
|
+
}
|
|
178
|
+
};
|
|
179
|
+
});
|
|
180
|
+
const send = (id: number, method: string, params?: object): void => {
|
|
181
|
+
// JSON-RPC allows `params` to be absent, but not `undefined`.
|
|
182
|
+
channel.port1.postMessage({ jsonrpc: "2.0", id, method, ...(params === undefined ? {} : { params }) });
|
|
183
|
+
};
|
|
184
|
+
send(1, "hello", { editorVersion: "0.1.0", protocol: PROTOCOL_VERSION });
|
|
185
|
+
send(2, "play");
|
|
186
|
+
send(3, "step", { deltaSeconds: 1 / 60 });
|
|
187
|
+
await done;
|
|
188
|
+
console.log(JSON.stringify(answers.at(-1)));
|
|
189
|
+
|
|
190
|
+
channel.port1.close();
|
|
191
|
+
controls.dispose();
|
|
192
|
+
app.dispose();
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## File formats
|
|
196
|
+
|
|
197
|
+
None. The scene view loads the project's own scene files through the normal loader; the editor's
|
|
198
|
+
document model lives in the editor.
|
|
199
|
+
|
|
200
|
+
## Gotchas
|
|
201
|
+
|
|
202
|
+
- **List `editorHostPlugin` for `vite build` too** when `main.ts` imports `virtual:ignifx/editor`:
|
|
203
|
+
the build half is what turns it into an empty function. Without the plugin the import does not
|
|
204
|
+
resolve.
|
|
205
|
+
- **`editorOrigin` is exact.** It must equal `event.origin` as the browser reports it, with no path or
|
|
206
|
+
trailing slash: `ignifx://app` for the packaged editor, `http://localhost:<port>` for the editor's
|
|
207
|
+
own dev server. A mismatch is silent by design: the host just never connects.
|
|
208
|
+
- **Every view reload needs a new port.** A transferred `MessagePort` cannot be posted twice; the
|
|
209
|
+
editor makes a fresh `MessageChannel` on each `load`, and the host closes the previous port.
|
|
210
|
+
- **The scene view runs in edit mode** (`createApp({ editMode: true })`, ADR-0028): a script gets no
|
|
211
|
+
callback unless its class sets `static runInEditMode = true`, and physics does not step. Pass
|
|
212
|
+
`editMode: false` to `startEditorHost` to run it as a second copy of the game. The play view is the
|
|
213
|
+
game's own app and is never in edit mode.
|
|
214
|
+
- **The engine version is read from the project.** `VERSION` from `@ignifx/core` is `"0.0.0"` when
|
|
215
|
+
core runs from source rather than its build, so the plugin reads `@ignifx/core/package.json` and
|
|
216
|
+
passes `engineVersion`; the host prefers a stamped `VERSION`.
|
|
217
|
+
- **Script edits reload both views** while `main.ts` imports `src/scripts/**` statically: Vite's one
|
|
218
|
+
module graph sends a full reload to every page when an update reaches a module that does not
|
|
219
|
+
accept it.
|
|
220
|
+
|
|
221
|
+
## Deprecated (current window)
|
|
222
|
+
|
|
223
|
+
None (pre-1.0: no deprecation window; breaking changes are listed in the changelog).
|
|
224
|
+
|
|
225
|
+
## Where to look next
|
|
226
|
+
|
|
227
|
+
`docs/architecture/17-editor-host.md` for the design, the protocol and the security rules ·
|
|
228
|
+
`packages/editor-host/api/editor-host.api.md` and `editor-host-vite.api.md` for the exact surface ·
|
|
229
|
+
`skills/ignifx/SKILL.md` for the engine.
|
package/README.md
DELETED