worldorbit 2.5.13 → 2.5.16
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 +37 -11
- package/dist/browser/core/dist/index.js +1811 -386
- package/dist/browser/editor/dist/index.js +10534 -0
- package/dist/browser/markdown/dist/index.js +1477 -221
- package/dist/browser/viewer/dist/index.js +1569 -230
- package/dist/unpkg/core/dist/index.js +1814 -389
- package/dist/unpkg/editor/dist/index.js +10559 -0
- package/dist/unpkg/markdown/dist/index.js +1480 -224
- package/dist/unpkg/viewer/dist/index.js +1572 -233
- package/dist/unpkg/worldorbit-core.min.js +12 -5
- package/dist/unpkg/worldorbit-editor.min.js +812 -0
- package/dist/unpkg/worldorbit-markdown.min.js +32 -23
- package/dist/unpkg/worldorbit-viewer.min.js +55 -41
- package/dist/unpkg/worldorbit.js +1713 -231
- package/dist/unpkg/worldorbit.min.js +58 -44
- package/package.json +3 -2
- package/packages/core/README.md +5 -1
- package/packages/core/dist/atlas-edit.d.ts +2 -2
- package/packages/core/dist/atlas-edit.js +70 -7
- package/packages/core/dist/atlas-utils.d.ts +22 -0
- package/packages/core/dist/atlas-utils.js +189 -0
- package/packages/core/dist/atlas-validate.d.ts +2 -0
- package/packages/core/dist/atlas-validate.js +285 -0
- package/packages/core/dist/draft-parse.js +786 -153
- package/packages/core/dist/draft.d.ts +3 -0
- package/packages/core/dist/draft.js +47 -3
- package/packages/core/dist/format.js +165 -9
- package/packages/core/dist/load.js +58 -13
- package/packages/core/dist/normalize.js +7 -0
- package/packages/core/dist/scene.js +66 -13
- package/packages/core/dist/types.d.ts +97 -3
- package/packages/editor/dist/editor.js +44 -0
- package/packages/markdown/README.md +1 -1
- package/packages/viewer/README.md +2 -1
- package/packages/viewer/dist/atlas-state.js +7 -1
- package/packages/viewer/dist/atlas-viewer.js +35 -1
- package/packages/viewer/dist/render.js +16 -7
- package/packages/viewer/dist/theme.js +4 -0
- package/packages/viewer/dist/tooltip.js +35 -0
- package/packages/viewer/dist/types.d.ts +7 -0
- package/packages/viewer/dist/viewer.js +4 -0
package/README.md
CHANGED
|
@@ -29,10 +29,12 @@ WorldOrbit is not intended to be a real-world astronomy simulator or a high-prec
|
|
|
29
29
|
## Quick Example
|
|
30
30
|
|
|
31
31
|
```worldorbit
|
|
32
|
-
schema 2.
|
|
32
|
+
schema 2.1
|
|
33
33
|
|
|
34
34
|
system Iyath
|
|
35
35
|
title "Iyath System"
|
|
36
|
+
epoch "JY-0001.0"
|
|
37
|
+
referencePlane ecliptic
|
|
36
38
|
|
|
37
39
|
defaults
|
|
38
40
|
view isometric
|
|
@@ -40,6 +42,10 @@ defaults
|
|
|
40
42
|
preset atlas-card
|
|
41
43
|
theme atlas
|
|
42
44
|
|
|
45
|
+
group inner-system
|
|
46
|
+
label "Inner System"
|
|
47
|
+
color #d9b37a
|
|
48
|
+
|
|
43
49
|
object star Iyath
|
|
44
50
|
|
|
45
51
|
object planet Naar
|
|
@@ -50,6 +56,7 @@ object planet Naar
|
|
|
50
56
|
inclination 24deg
|
|
51
57
|
phase 42deg
|
|
52
58
|
atmosphere nitrogen-oxygen
|
|
59
|
+
groups inner-system
|
|
53
60
|
````
|
|
54
61
|
|
|
55
62
|
## Installation
|
|
@@ -92,7 +99,7 @@ For direct browser usage, use the browser bundle:
|
|
|
92
99
|
<html>
|
|
93
100
|
<head>
|
|
94
101
|
<meta charset="utf-8" />
|
|
95
|
-
|
|
102
|
+
<script src="https://unpkg.com/worldorbit@2.5.16/dist/unpkg/worldorbit.min.js"></script>
|
|
96
103
|
<style>
|
|
97
104
|
html, body {
|
|
98
105
|
margin: 0;
|
|
@@ -111,9 +118,10 @@ For direct browser usage, use the browser bundle:
|
|
|
111
118
|
|
|
112
119
|
<script>
|
|
113
120
|
const source = `
|
|
114
|
-
schema 2.
|
|
121
|
+
schema 2.1
|
|
115
122
|
|
|
116
123
|
system Iyath
|
|
124
|
+
epoch "JY-0001.0"
|
|
117
125
|
|
|
118
126
|
object star Iyath
|
|
119
127
|
object planet Naar
|
|
@@ -165,19 +173,21 @@ The editor is optional. The core format remains text-first.
|
|
|
165
173
|
|
|
166
174
|
## Canonical Schema
|
|
167
175
|
|
|
168
|
-
|
|
176
|
+
New atlas authoring should start with:
|
|
169
177
|
|
|
170
178
|
```worldorbit
|
|
171
|
-
schema 2.
|
|
179
|
+
schema 2.1
|
|
172
180
|
```
|
|
173
181
|
|
|
174
182
|
Example:
|
|
175
183
|
|
|
176
184
|
```worldorbit
|
|
177
|
-
schema 2.
|
|
185
|
+
schema 2.1
|
|
178
186
|
|
|
179
187
|
system Iyath
|
|
180
188
|
title "Iyath System"
|
|
189
|
+
epoch "JY-0001.0"
|
|
190
|
+
referencePlane ecliptic
|
|
181
191
|
|
|
182
192
|
defaults
|
|
183
193
|
view isometric
|
|
@@ -185,10 +195,17 @@ defaults
|
|
|
185
195
|
preset atlas-card
|
|
186
196
|
theme atlas
|
|
187
197
|
|
|
198
|
+
group inner-system
|
|
199
|
+
label "Inner System"
|
|
200
|
+
summary "Naar and its inhabited infrastructure"
|
|
201
|
+
color #d9b37a
|
|
202
|
+
|
|
188
203
|
viewpoint overview
|
|
189
204
|
label "Atlas Overview"
|
|
190
205
|
summary "Fit the whole system."
|
|
191
206
|
projection isometric
|
|
207
|
+
filter
|
|
208
|
+
groups inner-system
|
|
192
209
|
|
|
193
210
|
annotation naar-notes
|
|
194
211
|
label "Naar Notes"
|
|
@@ -196,6 +213,7 @@ annotation naar-notes
|
|
|
196
213
|
body "Heimatwelt der Enari."
|
|
197
214
|
|
|
198
215
|
object star Iyath
|
|
216
|
+
mass 1.02sol
|
|
199
217
|
|
|
200
218
|
object planet Naar
|
|
201
219
|
orbit Iyath
|
|
@@ -204,11 +222,14 @@ object planet Naar
|
|
|
204
222
|
angle 28deg
|
|
205
223
|
inclination 24deg
|
|
206
224
|
phase 42deg
|
|
225
|
+
groups inner-system
|
|
207
226
|
image /demo/assets/naar-map.png
|
|
208
227
|
atmosphere nitrogen-oxygen
|
|
209
228
|
```
|
|
210
229
|
|
|
211
|
-
|
|
230
|
+
Schema `2.1` adds comments, semantic `group` and `relation` sections, object-level `epoch` and `referencePlane`, declarative resonance and validation hints, and optional structured lore blocks such as `climate`, `habitability`, and `settlement`.
|
|
231
|
+
|
|
232
|
+
Stable `1.0` source is still accepted. Canonical `schema 2.0` source remains fully supported, and legacy `schema 2.0-draft` files stay readable as a compatibility path with a deprecation diagnostic.
|
|
212
233
|
|
|
213
234
|
## Basic Usage
|
|
214
235
|
|
|
@@ -227,7 +248,7 @@ planet Naar orbit Iyath distance 1.18au
|
|
|
227
248
|
`.trim());
|
|
228
249
|
|
|
229
250
|
const loaded = loadWorldOrbitSource(`
|
|
230
|
-
schema 2.
|
|
251
|
+
schema 2.1
|
|
231
252
|
|
|
232
253
|
system Iyath
|
|
233
254
|
object star Iyath
|
|
@@ -330,7 +351,7 @@ const atlasDocument = upgradeDocumentToV2(stable.document, {
|
|
|
330
351
|
preset: "atlas-card",
|
|
331
352
|
});
|
|
332
353
|
|
|
333
|
-
const atlasSource = formatDocument(atlasDocument, { schema: "2.
|
|
354
|
+
const atlasSource = formatDocument(atlasDocument, { schema: "2.1" });
|
|
334
355
|
const loaded = loadWorldOrbitSource(atlasSource);
|
|
335
356
|
const parsedAtlas = parseWorldOrbitAtlas(atlasSource);
|
|
336
357
|
const scene = renderDocumentToScene(loaded.document, {
|
|
@@ -349,12 +370,13 @@ Viewer features in `v2.5` include:
|
|
|
349
370
|
* scene-based SVG rendering
|
|
350
371
|
* projections: `topdown` and `isometric`
|
|
351
372
|
* theme presets: `atlas`, `nightglass`, `ember`
|
|
352
|
-
* layer controls for background, guides, orbits, objects, labels, and
|
|
373
|
+
* layer controls for background, guides, orbits, objects, labels, metadata, and relations
|
|
353
374
|
* selection, hover, focus, fit, pan, zoom, and rotate
|
|
354
375
|
* tooltip cards and object detail payloads
|
|
355
376
|
* viewpoints, filters, search, and bookmark capture
|
|
356
377
|
* deep-linkable atlas state
|
|
357
378
|
* embeddable viewer custom elements
|
|
379
|
+
* semantic group filters, relation overlays, and schema 2.1 detail metadata
|
|
358
380
|
|
|
359
381
|
## Markdown Integration
|
|
360
382
|
|
|
@@ -395,6 +417,7 @@ Examples live in:
|
|
|
395
417
|
* [examples/minimal.worldorbit](./examples/minimal.worldorbit)
|
|
396
418
|
* [examples/iyath.worldorbit](./examples/iyath.worldorbit)
|
|
397
419
|
* [examples/iyath.schema2.worldorbit](./examples/iyath.schema2.worldorbit)
|
|
420
|
+
* [examples/iyath.schema21.worldorbit](./examples/iyath.schema21.worldorbit)
|
|
398
421
|
* [examples/iyath.schema2-draft.worldorbit](./examples/iyath.schema2-draft.worldorbit)
|
|
399
422
|
* [examples/markdown/static.md](./examples/markdown/static.md)
|
|
400
423
|
* [examples/markdown/interactive.md](./examples/markdown/interactive.md)
|
|
@@ -406,6 +429,9 @@ Browser-facing examples and demos live in the repository under `demo/`, `studio/
|
|
|
406
429
|
|
|
407
430
|
* [migration guide: v0.8 to v1.0](./docs/migration-v0.8-to-v1.0.md)
|
|
408
431
|
* [migration guide: v1 to v2](./docs/migration-v1-to-v2.md)
|
|
432
|
+
* [migration guide: v2.0 to v2.1](./docs/migration-v2-to-v2.1.md)
|
|
433
|
+
* [language reference](./docs/language-reference.md)
|
|
434
|
+
* [language reference (DE)](./docs/language-reference.de.md)
|
|
409
435
|
* [API inventory](./docs/api-inventory.md)
|
|
410
436
|
* [changelog](./docs/changelog.md)
|
|
411
437
|
|
|
@@ -439,4 +465,4 @@ The long-term focus is:
|
|
|
439
465
|
|
|
440
466
|
## License
|
|
441
467
|
|
|
442
|
-
MIT
|
|
468
|
+
MIT
|