@onlyworlds/sdk 3.1.0 → 4.0.0-alpha.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/AGENTS.md +4 -0
- package/CHANGELOG.md +86 -44
- package/README.md +83 -271
- package/SCHEMA.md +630 -0
- package/dist/index.d.ts +463 -1469
- package/dist/index.js +691 -994
- package/package.json +14 -6
- package/dist/index.d.mts +0 -3517
- package/dist/index.mjs +0 -1576
package/SCHEMA.md
ADDED
|
@@ -0,0 +1,630 @@
|
|
|
1
|
+
# OnlyWorlds Schema Reference
|
|
2
|
+
|
|
3
|
+
GENERATED from the canonical schema YAML — do not hand-edit (regenerate: `python codegen/generate_types.py`).
|
|
4
|
+
Written for both humans and AI agents reading this package locally.
|
|
5
|
+
|
|
6
|
+
**The shape rules** (v2 wire dialect): every element carries `id` (UUID), `name`, optional
|
|
7
|
+
`description`/`supertype`/`subtype`/`image_url`, server-managed `type`/`created_at`/`updated_at`/`change_seq`,
|
|
8
|
+
and namespaced extension fields (`x_*` etc.) returned verbatim. Link fields use ONE bare
|
|
9
|
+
name in both read and write (no `_ids` suffix). Single links are `UUID | null`; multi links
|
|
10
|
+
are `UUID[]`. **Links are owned one-way**: the type listed below owns the field (e.g.
|
|
11
|
+
Character owns `abilities`; Ability has no `characters`). Sections and their order are the
|
|
12
|
+
canonical display grouping.
|
|
13
|
+
|
|
14
|
+
Families (colour semantics; icon carries the type): agents · world · abstract · temporal.
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## ability · family: abstract · icon: auto_fix_normal
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Mechanics
|
|
21
|
+
|
|
22
|
+
- `activation` (text) — Method or conditions under which the ability is activated
|
|
23
|
+
- `duration` (integer) — Length of time the ability remains active or its effects persist, measured in TIME units
|
|
24
|
+
- `potency` (integer) — Relative measure of the ability's inherent potency or force, used for scaling or comparison purposes
|
|
25
|
+
- `range` (integer) — Effective reach or distance at which the ability can be used, measured in DISTANCE units
|
|
26
|
+
- `effects` (multi link → phenomenon) — Phenomena that result from the ability's use, such as environmental changes or sensory effects
|
|
27
|
+
- `challenges` (text) — Describes specific difficulties or constraints that make the ability hard to master or use effectively
|
|
28
|
+
- `talents` (multi link → trait) — Traits that naturally enhance or improve performance with this ability
|
|
29
|
+
- `requisites` (multi link → construct) — Constructs that must be satisfied for the ability to be used, such as rituals, permissions, or required roles
|
|
30
|
+
|
|
31
|
+
### World
|
|
32
|
+
|
|
33
|
+
- `prevalence` (text) — How widely the ability is known or practiced, and potential clues to its origins and cultural diffusion
|
|
34
|
+
- `tradition` (single link → construct) — A construct that expresses the conceptual, social, or institutional system this ability operates within
|
|
35
|
+
- `source` (single link → phenomenon) — The phenomenon that serves as the enabling force or condition that allows this ability to function
|
|
36
|
+
- `locus` (single link → location) — Location where the ability is most strongly rooted, developed, or traditionally practiced
|
|
37
|
+
- `instruments` (multi link → object) — Objects or tools required to activate, channel, or perform the ability
|
|
38
|
+
- `systems` (multi link → construct) — Magic frameworks or structures that the ability associates with
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## character · family: agents · icon: person
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Constitution
|
|
45
|
+
|
|
46
|
+
- `physicality` (text) — The character's visible physical features and body attributes
|
|
47
|
+
- `mentality` (text) — The character's mindset, emotional tone, and style of thinking
|
|
48
|
+
- `height` (integer) — The character's approximate or exact height, using world LENGTH units
|
|
49
|
+
- `weight` (integer) — The character's approximate or exact weight, using world MASS units
|
|
50
|
+
- `species` (multi link → species) — Species the character might belong to
|
|
51
|
+
- `traits` (multi link → trait) — Traits for notable behavioral, physical, or systemic characteristics
|
|
52
|
+
- `abilities` (multi link → ability) — Abilities the character might perform, control, or invoke
|
|
53
|
+
|
|
54
|
+
### Origins
|
|
55
|
+
|
|
56
|
+
- `background` (text) — History, upbringing, or formative experiences of the character
|
|
57
|
+
- `motivations` (text) — Core desires, goals, or values that drive the character's choices and behavior
|
|
58
|
+
- `birth_date` (integer) — Moment of birth, expressed in the world's TIME units
|
|
59
|
+
- `birthplace` (single link → location) — Location where the character was born
|
|
60
|
+
- `languages` (multi link → language) — Languages the character can understand, speak, or use for communication
|
|
61
|
+
|
|
62
|
+
### World
|
|
63
|
+
|
|
64
|
+
- `reputation` (text) — Brief summary of the character's current condition, role, or predicament
|
|
65
|
+
- `location` (single link → location) — The character's present physical location
|
|
66
|
+
- `objects` (multi link → object) — Key objects owned by or symbolically linked to the character
|
|
67
|
+
- `institutions` (multi link → institution) — Institutions the character is affiliated with
|
|
68
|
+
|
|
69
|
+
### Personality
|
|
70
|
+
|
|
71
|
+
- `charisma` (integer) — Ability to attract, inspire, and influence others
|
|
72
|
+
- `coercion` (integer) — Capacity to dominate, intimidate, or apply force to shape outcomes
|
|
73
|
+
- `competence` (integer) — Skill in planning, understanding, and managing complex systems or situations
|
|
74
|
+
- `compassion` (integer) — Willingness to empathize with and care for others
|
|
75
|
+
- `creativity` (integer) — Ability to generate novel ideas, perspectives, or solutions
|
|
76
|
+
- `courage` (integer) — Readiness to face danger, risk, or adversity
|
|
77
|
+
|
|
78
|
+
### Social
|
|
79
|
+
|
|
80
|
+
- `family` (multi link → family) — Families the character belongs to by blood or adoption
|
|
81
|
+
- `friends` (multi link → character) — Characters the character considers close allies or companions
|
|
82
|
+
- `rivals` (multi link → character) — Characters the character is in active opposition or competition with
|
|
83
|
+
|
|
84
|
+
### TTRPG
|
|
85
|
+
|
|
86
|
+
- `level` (integer) — Progression rank of the character in a game system
|
|
87
|
+
- `hit_points` (integer) — Total health available to the character
|
|
88
|
+
- `STR` (integer) — Physical force and carrying capacity
|
|
89
|
+
- `DEX` (integer) — Agility, coordination, and reflexes
|
|
90
|
+
- `CON` (integer) — Endurance and resistance to strain
|
|
91
|
+
- `INT` (integer) — Reasoning, memory, and learning
|
|
92
|
+
- `WIS` (integer) — Intuition, awareness, and judgment
|
|
93
|
+
- `CHA` (integer) — Persuasiveness and personal magnetism
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## collective · family: agents · icon: groups_3
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
### Formation
|
|
100
|
+
|
|
101
|
+
- `composition` (text) — Internal structure or demographic makeup of the collective
|
|
102
|
+
- `count` (integer) — Number of members in the collective (approximate or exact)
|
|
103
|
+
- `formation_date` (integer) — Date the collective was formed, using world TIME units
|
|
104
|
+
- `operator` (single link → institution) — Institution that manages or directs the collective
|
|
105
|
+
- `equipment` (multi link → object) — Tools or gear in possession of and/or regularly used by the collective
|
|
106
|
+
|
|
107
|
+
### Dynamics
|
|
108
|
+
|
|
109
|
+
- `activity` (text) — Primary behaviors or actions the collective engages in
|
|
110
|
+
- `disposition` (text) — Emotional control or volatility expressed by the collective
|
|
111
|
+
- `state` (text) — Current condition or operational status of the collective
|
|
112
|
+
- `abilities` (multi link → ability) — Abilities commonly shared among members of the collective, or abilities of that collective as a whole
|
|
113
|
+
- `symbolism` (multi link → construct) — Cultural expressions, rituals, or symbols that unify or distinguish the collective
|
|
114
|
+
|
|
115
|
+
### World
|
|
116
|
+
|
|
117
|
+
- `species` (multi link → species) — Species that compose or participate in the collective
|
|
118
|
+
- `characters` (multi link → character) — Characters who are members of the collective
|
|
119
|
+
- `creatures` (multi link → creature) — Creatures associated with or included in the collective
|
|
120
|
+
- `phenomena` (multi link → phenomenon) — Phenomena that influence or characterize the collective
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
## construct · family: world · icon: api
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### Nature
|
|
127
|
+
|
|
128
|
+
- `rationale` (text) — The internal reasoning, structure, or justification of how the construct functions or makes sense within the world
|
|
129
|
+
- `history` (text) — The historical development or ideation of the construct, and its place in wider historical contexts
|
|
130
|
+
- `status` (text) — The present condition or operational status of the construct
|
|
131
|
+
- `reach` (text) — The geographic, cultural, or political extent of the construct's influence
|
|
132
|
+
- `start_date` (integer) — The point in time when the construct began or was first established (uses world's TIME definition)
|
|
133
|
+
- `end_date` (integer) — The point in time when the construct ceased to function or lost its meaning
|
|
134
|
+
- `founder` (single link → character) — Character who conceived or initiated the construct
|
|
135
|
+
- `custodian` (single link → institution) — Institution maintaining, enforcing, or exploiting the construct
|
|
136
|
+
|
|
137
|
+
### Involves
|
|
138
|
+
|
|
139
|
+
- `characters` (multi link → character) — Characters relevant to the construct
|
|
140
|
+
- `objects` (multi link → object) — Objects relevant to the construct
|
|
141
|
+
- `locations` (multi link → location) — Locations relevant to the construct
|
|
142
|
+
- `species` (multi link → species) — Species relevant to the construct
|
|
143
|
+
- `creatures` (multi link → creature) — Creatures relevant to the construct
|
|
144
|
+
- `institutions` (multi link → institution) — Institutions relevant to the construct
|
|
145
|
+
- `traits` (multi link → trait) — Traits relevant to the construct
|
|
146
|
+
- `collectives` (multi link → collective) — Collectives relevant to the construct
|
|
147
|
+
- `zones` (multi link → zone) — Zones relevant to the construct
|
|
148
|
+
- `abilities` (multi link → ability) — Abilities relevant to the construct
|
|
149
|
+
- `phenomena` (multi link → phenomenon) — Phenomena relevant to the construct
|
|
150
|
+
- `languages` (multi link → language) — Languages relevant to the construct
|
|
151
|
+
- `families` (multi link → family) — Families relevant to the construct
|
|
152
|
+
- `relations` (multi link → relation)
|
|
153
|
+
- `titles` (multi link → title) — Titles relevant to the construct
|
|
154
|
+
- `constructs` (multi link → construct) — Other constructs relevant to the construct
|
|
155
|
+
- `events` (multi link → event) — Events relevant to the construct
|
|
156
|
+
- `narratives` (multi link → narrative) — Narratives relevant to the construct
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
## creature · family: agents · icon: bug_report
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### Biology
|
|
163
|
+
|
|
164
|
+
- `appearance` (text) — Visual description of the creature
|
|
165
|
+
- `weight` (integer) — Approximate or exact weight of the creature, using world MASS units
|
|
166
|
+
- `height` (integer) — Approximate height of the creature, using the world's defined LENGTH units
|
|
167
|
+
- `species` (multi link → species) — Species this creature belongs to
|
|
168
|
+
|
|
169
|
+
### Behavior
|
|
170
|
+
|
|
171
|
+
- `habits` (text) — Typical behaviors, instincts, or recurring actions the creature tends to display
|
|
172
|
+
- `demeanor` (text) — The emotional tone or attitude the creature conveys through posture, expression, or aggression
|
|
173
|
+
- `traits` (multi link → trait) — Traits that influence the creature's behavior, capabilities, or appearance
|
|
174
|
+
- `abilities` (multi link → ability) — Innate or learned abilities the creature can perform or activate
|
|
175
|
+
- `languages` (multi link → language) — Languages the creature can understand, speak, or otherwise use to communicate
|
|
176
|
+
|
|
177
|
+
### World
|
|
178
|
+
|
|
179
|
+
- `status` (text) — Current situation or classification of the creature
|
|
180
|
+
- `birth_date` (integer) — The time of the creature's birth, recorded in the world's defined TIME unit
|
|
181
|
+
- `location` (single link → location) — Specific location where the creature is currently found or most associated with
|
|
182
|
+
- `zone` (single link → zone) — Larger area or region commonly inhabited or currently claimed by the creature
|
|
183
|
+
|
|
184
|
+
### TTRPG
|
|
185
|
+
|
|
186
|
+
- `challenge_rating` (integer) — Difficulty or threat level of the creature in a gameplay context
|
|
187
|
+
- `hit_points` (integer) — Total health or durability value in combat
|
|
188
|
+
- `armor_class` (integer) — Defense rating against physical attacks or effects
|
|
189
|
+
- `speed` (integer) — Typical movement speed, measured in the world's DISTANCE unit per round
|
|
190
|
+
- `actions` (multi link → ability) — Combat or tactical abilities the creature can perform or use
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
## event · family: temporal · icon: saved_search
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
### Nature
|
|
197
|
+
|
|
198
|
+
- `history` (text) — Historical context and background of the event
|
|
199
|
+
- `challenges` (text) — Adversity or difficulties faced during the event
|
|
200
|
+
- `consequences` (text) — Outcomes and impacts resulting from the event
|
|
201
|
+
- `start_date` (integer) — Date on which the event began
|
|
202
|
+
- `end_date` (integer) — Date on which the event concluded
|
|
203
|
+
- `triggers` (multi link → event) — Events that eventuated the event
|
|
204
|
+
|
|
205
|
+
### Involves
|
|
206
|
+
|
|
207
|
+
- `characters` (multi link → character) — Key characters relevant to the event
|
|
208
|
+
- `objects` (multi link → object) — Objects relevant to the event
|
|
209
|
+
- `locations` (multi link → location) — Locations relevant to the event
|
|
210
|
+
- `species` (multi link → species) — Species relevant to the event
|
|
211
|
+
- `creatures` (multi link → creature) — Creatures relevant to the event
|
|
212
|
+
- `institutions` (multi link → institution) — Institutions relevant to the event
|
|
213
|
+
- `traits` (multi link → trait) — Traits relevant to the event
|
|
214
|
+
- `collectives` (multi link → collective) — Groups or collectives relevant to the event
|
|
215
|
+
- `zones` (multi link → zone) — Zones relevant to the event
|
|
216
|
+
- `abilities` (multi link → ability) — Abilities relevant to the event
|
|
217
|
+
- `phenomena` (multi link → phenomenon) — Natural or supernatural phenomena relevant to the event
|
|
218
|
+
- `languages` (multi link → language)
|
|
219
|
+
- `families` (multi link → family) — Families relevant to the event
|
|
220
|
+
- `relations` (multi link → relation) — Interpersonal or political relations relevant to the event
|
|
221
|
+
- `titles` (multi link → title) — Titles relevant to the event
|
|
222
|
+
- `constructs` (multi link → construct) — Concepts, laws, or built entities relevant to the event
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
## family · family: agents · icon: supervisor_account
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
### Identity
|
|
229
|
+
|
|
230
|
+
- `spirit` (text) — The core values or shared ethos that the family embodies
|
|
231
|
+
- `history` (text) — Background or origin story of the family
|
|
232
|
+
- `traditions` (multi link → construct) — Cultural practices, symbols, or customs overseen by the family
|
|
233
|
+
- `traits` (multi link → trait) — Traits possibly found among members of the family
|
|
234
|
+
- `abilities` (multi link → ability) — Abilities or special qualities possibly present in the family
|
|
235
|
+
- `languages` (multi link → language) — Languages spoken by, or associated with the family
|
|
236
|
+
- `ancestors` (multi link → character) — Notable forebears or historic characters in the family's lineage
|
|
237
|
+
|
|
238
|
+
### World
|
|
239
|
+
|
|
240
|
+
- `reputation` (text) — Current social, political, or general standing of the family
|
|
241
|
+
- `estates` (multi link → location) — Key locations owned, governed, or symbolically tied to the family
|
|
242
|
+
- `governs` (multi link → institution) — Institutions administered or managed by the family
|
|
243
|
+
- `heirlooms` (multi link → object) — Important objects or artifacts handed down by the family
|
|
244
|
+
- `creatures` (multi link → creature) — Creatures owned, bonded to, or representing the family
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## institution · family: agents · icon: business
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
### Foundation
|
|
251
|
+
|
|
252
|
+
- `doctrine` (text) — Core belief, mission, or purpose that drives the institution
|
|
253
|
+
- `founding_date` (integer) — Date when the institution was established, in the world's TIME format
|
|
254
|
+
- `parent_institution` (single link → institution) — Institution that governs, embodies, or originated this one
|
|
255
|
+
|
|
256
|
+
### Claims
|
|
257
|
+
|
|
258
|
+
- `zones` (multi link → zone) — Areas the institution controls or claims authority over
|
|
259
|
+
- `objects` (multi link → object) — Significant objects owned or tied to the institution's operations, holdings, or identity
|
|
260
|
+
- `creatures` (multi link → creature) — Creatures under the institution's protection, use, or symbolic control
|
|
261
|
+
|
|
262
|
+
### World
|
|
263
|
+
|
|
264
|
+
- `status` (text) — Current political, cultural, or functional standing of the institution in the world
|
|
265
|
+
- `allies` (multi link → institution) — Institutions this one actively cooperates or aligns with
|
|
266
|
+
- `adversaries` (multi link → institution) — Institutions this one opposes, competes with, or is in conflict with
|
|
267
|
+
- `constructs` (multi link → construct) — Conceptual, procedural, or structural systems created or maintained by the institution
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
## language · family: abstract · icon: edit_road
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
### Structure
|
|
274
|
+
|
|
275
|
+
- `phonology` (text) — The language's sound systems, including phonemes, tone, and pronunciation rules
|
|
276
|
+
- `grammar` (text) — Rules governing syntax, morphology, and sentence structure
|
|
277
|
+
- `lexicon` (text) — Vocabulary principles or full word lists used in the language
|
|
278
|
+
- `writing` (text) — Script or notation system used to represent the language in written form
|
|
279
|
+
- `classification` (single link → construct) — Linguistic group or typological category the language belongs to
|
|
280
|
+
|
|
281
|
+
### World
|
|
282
|
+
|
|
283
|
+
- `status` (text) — Current vitality, reputation, or dominance of the language
|
|
284
|
+
- `spread` (multi link → location) — Geographical areas where the language is used or spoken
|
|
285
|
+
- `dialects` (multi link → language) — Variants or dialect languages derived from the language
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
## law · family: abstract · icon: gpp_bad
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
### Code
|
|
292
|
+
|
|
293
|
+
- `declaration` (text) — The formal wording, expression, or decree of the law
|
|
294
|
+
- `purpose` (text) — The intent, motivation, or justification for the law's creation
|
|
295
|
+
- `date` (integer) — Date the law was formally established, in world TIME units
|
|
296
|
+
- `parent_law` (single link → law) — A law that this law derives from, modifies, or enhances
|
|
297
|
+
- `penalties` (multi link → construct) — Consequences intended to beapplied when the law is contravened
|
|
298
|
+
|
|
299
|
+
### World
|
|
300
|
+
|
|
301
|
+
- `author` (single link → institution) — The institution that created or issued the law
|
|
302
|
+
- `locations` (multi link → location) — Locations where the law is supported or enforced
|
|
303
|
+
- `zones` (multi link → zone) — Zones where the law is supported or enforced
|
|
304
|
+
- `prohibitions` (multi link → construct) — Things that the law explicitly or effectively forbids
|
|
305
|
+
- `adjudicators` (multi link → title) — Titles responsible for interpreting or ruling on the law's application and jurisdiction
|
|
306
|
+
- `enforcers` (multi link → title) — Titles responsible for enforcing or imposing the law
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
## location · family: world · icon: castle
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
### Setting
|
|
313
|
+
|
|
314
|
+
- `form` (text) — Visual and environmental aspects of the location
|
|
315
|
+
- `function` (text) — Main use, role, or purpose of the location within the world
|
|
316
|
+
- `founding_date` (integer) — Date on which the location was founded, established, or designated
|
|
317
|
+
- `parent_location` (single link → location) — Wider location that this location is part of
|
|
318
|
+
- `populations` (multi link → collective) — Distinct collective groups or communities residing within the location
|
|
319
|
+
|
|
320
|
+
### Politics
|
|
321
|
+
|
|
322
|
+
- `political_climate` (text) — Political structure, stability, and dynamics of the location
|
|
323
|
+
- `primary_power` (single link → institution) — Institution that has the highest degree of political control over the location
|
|
324
|
+
- `governing_title` (single link → title) — Governing figure assigned by the location's primary power
|
|
325
|
+
- `secondary_powers` (multi link → institution) — Institutions with significant political control
|
|
326
|
+
- `zone` (single link → zone) — Zone of interest that is associated with the location
|
|
327
|
+
- `rival` (single link → location) — Locations with active, traditional, or historical rivalries
|
|
328
|
+
- `partner` (single link → location) — Locations with active, cooperative, or historical ties
|
|
329
|
+
|
|
330
|
+
### World
|
|
331
|
+
|
|
332
|
+
- `customs` (text) — Cultural practices, habits, or festivals
|
|
333
|
+
- `founders` (multi link → character) — Individual(s) who founded or named the location
|
|
334
|
+
- `cults` (multi link → construct) — Significant religious constructs practiced or recognized at the location
|
|
335
|
+
- `delicacies` (multi link → species) — Organisms or other species locally consumed or celebrated as specialty foods
|
|
336
|
+
|
|
337
|
+
### Production
|
|
338
|
+
|
|
339
|
+
- `extraction_methods` (multi link → construct) — Techniques or strategies used to gather natural resources
|
|
340
|
+
- `extraction_goods` (multi link → construct) — Products and materials that are gathered or obtained
|
|
341
|
+
- `industry_methods` (multi link → construct) — Techniques or workflows used to refine or manufacture goods
|
|
342
|
+
- `industry_goods` (multi link → construct) — Products and materials that are refined or manufactured
|
|
343
|
+
|
|
344
|
+
### Commerce
|
|
345
|
+
|
|
346
|
+
- `infrastructure` (text) — Roads, ports, and other physical systems that enable the movement of goods and people
|
|
347
|
+
- `extraction_markets` (multi link → location) — Locations that receive extracted goods through trade, interchange, or seizure
|
|
348
|
+
- `industry_markets` (multi link → location) — Locations that receive industrial goods through trade, interchange, or seizure
|
|
349
|
+
- `currencies` (multi link → construct) — Trade media recognized or circulated at the location
|
|
350
|
+
|
|
351
|
+
### Construction
|
|
352
|
+
|
|
353
|
+
- `architecture` (text) — Look, form, and materials used in the built environment and location design
|
|
354
|
+
- `buildings` (multi link → object) — Notable structural objects at the location
|
|
355
|
+
- `building_methods` (multi link → construct) — Techniques or systems used to construct structures at the location
|
|
356
|
+
|
|
357
|
+
### Defense
|
|
358
|
+
|
|
359
|
+
- `defensibility` (text) — Qualities of natural, constructed, and implemented defenses at the location
|
|
360
|
+
- `elevation` (integer) — Height or elevation of the location relative to surrounding terrain, defined in world DISTANCE units
|
|
361
|
+
- `fighters` (multi link → construct) — Military units or forces responsible for defending the location
|
|
362
|
+
- `defensive_objects` (multi link → object) — Objects or installations for defending the location
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
## map · family: world · icon: map
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
### Details
|
|
369
|
+
|
|
370
|
+
- `background_color` (text) — Color of the space around the map when zoomed out
|
|
371
|
+
- `hierarchy` (integer) — To associate or differentiate between maps with a common parent
|
|
372
|
+
- `width` (integer) — In pixels
|
|
373
|
+
- `height` (integer) — In pixels
|
|
374
|
+
- `depth` (integer) — In pixels
|
|
375
|
+
- `parent_map` (single link → map) — Map within which this map is contained
|
|
376
|
+
- `location` (single link → location) — Location element that this map represents
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
## marker · family: world · icon: place
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
### Details
|
|
383
|
+
|
|
384
|
+
- `map` (single link → map) — Map this marker is placed on
|
|
385
|
+
- `zone` (single link → zone) — Zone that is defined by this marker
|
|
386
|
+
- `x` (integer) — x coordinate, from bottom left of the map
|
|
387
|
+
- `y` (integer) — y coordinate, from bottom left of the map
|
|
388
|
+
- `z` (integer) — z coordinate, in case of depth
|
|
389
|
+
- `order` (integer) — Sequence position when markers define a polygon or line (0 = first point)
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
## narrative · family: temporal · icon: menu_book
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### Context
|
|
396
|
+
|
|
397
|
+
- `story` (text) — Content of the narrative, as told or remembered
|
|
398
|
+
- `consequences` (text) — Outcomes or legacy of the narrative
|
|
399
|
+
- `start_date` (integer) — Date when the narrative begins, measured in world TIME units
|
|
400
|
+
- `end_date` (integer) — Date when the narrative ends, measured in world TIME units
|
|
401
|
+
- `order` (integer) — Position of this narrative within a parent narrative's sequence
|
|
402
|
+
- `parent_narrative` (single link → narrative) — Larger narrative that this narrative takes place in
|
|
403
|
+
- `protagonist` (single link → character) — Primary character of the narrative
|
|
404
|
+
- `antagonist` (single link → character) — Opposing character of the narrative
|
|
405
|
+
- `narrator` (single link → character) — Character credited with telling or recording the narrative
|
|
406
|
+
- `conservator` (single link → institution) — Institution that preserves or curates the narrative
|
|
407
|
+
|
|
408
|
+
### Involves
|
|
409
|
+
|
|
410
|
+
- `events` (multi link → event) — Events relevant to the narrative
|
|
411
|
+
- `characters` (multi link → character) — Characters relevant to the narrative
|
|
412
|
+
- `objects` (multi link → object) — Objects relevant to the narrative
|
|
413
|
+
- `locations` (multi link → location) — Locations relevant to the narrative
|
|
414
|
+
- `species` (multi link → species) — Species relevant to the narrative
|
|
415
|
+
- `creatures` (multi link → creature) — Creatures relevant to the narrative
|
|
416
|
+
- `institutions` (multi link → institution) — Institutions relevant to the narrative
|
|
417
|
+
- `traits` (multi link → trait) — Traits relevant to the narrative
|
|
418
|
+
- `collectives` (multi link → collective) — Groups relevant to the narrative
|
|
419
|
+
- `zones` (multi link → zone) — Zones relevant to the narrative
|
|
420
|
+
- `abilities` (multi link → ability) — Abilities relevant to the narrative
|
|
421
|
+
- `phenomena` (multi link → phenomenon) — Phenomena relevant to the narrative
|
|
422
|
+
- `languages` (multi link → language) — Languages relevant to the narrative
|
|
423
|
+
- `families` (multi link → family) — Families relevant to the narrative
|
|
424
|
+
- `relations` (multi link → relation) — Relationships relevant to the narrative
|
|
425
|
+
- `titles` (multi link → title) — Titles relevant to the narrative
|
|
426
|
+
- `constructs` (multi link → construct) — Constructs relevant to the narrative
|
|
427
|
+
- `laws` (multi link → law) — Laws relevant to the narrative
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
## object · family: world · icon: webhook
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
### Form
|
|
434
|
+
|
|
435
|
+
- `aesthetics` (text) — Appearance, design, or visual presentation of the object
|
|
436
|
+
- `weight` (integer) — Approximate or exact mass of the object, defined by world MASS units
|
|
437
|
+
- `amount` (integer) — The number of identical units in this object entry
|
|
438
|
+
- `parent_object` (single link → object) — Larger object that this one is part of or contained within
|
|
439
|
+
- `materials` (multi link → construct) — The phyiscal matter that constitutes the object
|
|
440
|
+
- `technology` (multi link → construct) — Mechanisms relating the object's design or operation
|
|
441
|
+
|
|
442
|
+
### Function
|
|
443
|
+
|
|
444
|
+
- `utility` (text) — Intended purpose or primary use of the object
|
|
445
|
+
- `effects` (multi link → phenomenon) — Phenomena potentially triggered or emitted on object use
|
|
446
|
+
- `abilities` (multi link → ability) — Abilities that the object grant or enables
|
|
447
|
+
- `consumes` (multi link → construct) — What might be used or depleted on object use
|
|
448
|
+
|
|
449
|
+
### World
|
|
450
|
+
|
|
451
|
+
- `origins` (text) — Background or history of the object
|
|
452
|
+
- `location` (single link → location) — Physical place where the object is currently located or stored
|
|
453
|
+
- `language` (single link → language) — Required to read, understand, or activate the object
|
|
454
|
+
- `affinities` (multi link → trait) — Traits that resonate with or enhance the object's use, function, or effects
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
## phenomenon · family: temporal · icon: thunderstorm
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
### Mechanics
|
|
461
|
+
|
|
462
|
+
- `expression` (text) — How the phenomenon manifests or takes shape in the world
|
|
463
|
+
- `effects` (text) — The primary outcomes or changes caused by the phenomenon
|
|
464
|
+
- `duration` (integer) — The amount of time the phenomenon lasts, measured in world TIME units
|
|
465
|
+
- `catalysts` (multi link → object) — Objects or materials that initiate or enhance the phenomenon
|
|
466
|
+
- `empowerments` (multi link → ability) — Abilities that initiate or enhance the phenomenon, or are initiated or enhanced by it
|
|
467
|
+
|
|
468
|
+
### World
|
|
469
|
+
|
|
470
|
+
- `mythology` (text) — Cultural, religious, or narrative meaning associated with the phenomenon
|
|
471
|
+
- `system` (single link → phenomenon) — Broader phenomenon that this one is part of or linked to
|
|
472
|
+
- `triggers` (multi link → construct) — Conceptual mechanisms or patterns that cause the phenomenon to activate
|
|
473
|
+
- `wielders` (multi link → character) — Characters capable of intentionally directing or controlling the phenomenon
|
|
474
|
+
- `environments` (multi link → location) — Locations where the phenomenon occurs or is known to manifest
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
## pin · family: world · icon: push_pin
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
### Details
|
|
481
|
+
|
|
482
|
+
- `map` (single link → map) — Map that the pin is placed on
|
|
483
|
+
- `element` (generic link (any element type)) — Link to any Element (managed by ContentType + UUID)
|
|
484
|
+
- `x` (integer) — x coordinate, from bottom left of the map
|
|
485
|
+
- `y` (integer) — y coordinate, from bottom left of the map
|
|
486
|
+
- `z` (integer) — z coordinate, in case of depth (optional)
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
## relation · family: temporal · icon: link
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
### Nature
|
|
493
|
+
|
|
494
|
+
- `background` (text) — History and origin of the relation
|
|
495
|
+
- `start_date` (integer) — Date when the relation began, defined in world TIME units
|
|
496
|
+
- `end_date` (integer) — Date when the relation ended if any, defined in world TIME units
|
|
497
|
+
- `intensity` (integer) — Significance of the relation, on a relative scale of 0 to 100
|
|
498
|
+
- `actor` (single link → character) — Primary character defining the relation
|
|
499
|
+
- `events` (multi link → event) — Events where the relation is involved or relevant
|
|
500
|
+
|
|
501
|
+
### Involves
|
|
502
|
+
|
|
503
|
+
- `characters` (multi link → character) — Characters relevant to the relation
|
|
504
|
+
- `objects` (multi link → object) — Objects relevant to the relation
|
|
505
|
+
- `locations` (multi link → location) — Locations relevant to the relation
|
|
506
|
+
- `species` (multi link → species) — Species relevant to the relation
|
|
507
|
+
- `creatures` (multi link → creature) — Creatures relevant to the relation
|
|
508
|
+
- `institutions` (multi link → institution) — Institutions relevant to the relation
|
|
509
|
+
- `traits` (multi link → trait) — Traits relevant to the relation
|
|
510
|
+
- `collectives` (multi link → collective) — Collectives relevant to the relation
|
|
511
|
+
- `zones` (multi link → zone) — Zones relevant to the relation
|
|
512
|
+
- `abilities` (multi link → ability) — Abilities relevant to the relation
|
|
513
|
+
- `phenomena` (multi link → phenomenon) — Phenomena relevant to the relation
|
|
514
|
+
- `languages` (multi link → language) — Languages relevant to the relation
|
|
515
|
+
- `families` (multi link → family) — Families relevant to the relation
|
|
516
|
+
- `titles` (multi link → title) — Titles relevant to the relation
|
|
517
|
+
- `constructs` (multi link → construct) — Concepts, contracts, or principles relevant to the relation
|
|
518
|
+
- `events` (multi link → event) — Events where the relation is involved or relevant
|
|
519
|
+
- `narratives` (multi link → narrative) — Narratives relevant to the relation
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
## species · family: agents · icon: crib
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
### Biology
|
|
526
|
+
|
|
527
|
+
- `appearance` (text) — Typical physical or form features of the species
|
|
528
|
+
- `life_span` (integer) — Average or typical life expectancy of an individual, defined in world TIME units
|
|
529
|
+
- `weight` (integer) — Average or typical adult weight, defined in world MASS units
|
|
530
|
+
- `nourishment` (multi link → species) — Other species consumed as food sources
|
|
531
|
+
- `reproduction` (multi link → construct) — Reproductive method(s) of the species
|
|
532
|
+
- `adaptations` (multi link → ability) — Special physiological or evolutionary abilities
|
|
533
|
+
|
|
534
|
+
### Psychology
|
|
535
|
+
|
|
536
|
+
- `instincts` (text) — Innate behavioral drives and survival tendencies
|
|
537
|
+
- `sociality` (text) — Typical patterns of social behavior
|
|
538
|
+
- `temperament` (text) — Overall behavioral disposition
|
|
539
|
+
- `communication` (text) — Typical methods and approaches of interaction
|
|
540
|
+
- `aggression` (integer) — General aggressiveness level, on relative scale of 0 to 100
|
|
541
|
+
- `traits` (multi link → trait) — Behavioral patterns associated with the species
|
|
542
|
+
|
|
543
|
+
### World
|
|
544
|
+
|
|
545
|
+
- `role` (text) — The species' ecological or cultural function in the world
|
|
546
|
+
- `parent_species` (single link → species) — Species that the species is considered a subspecies of
|
|
547
|
+
- `locations` (multi link → location) — Locations associated with the species or its habitat
|
|
548
|
+
- `zones` (multi link → zone) — Zones associated with the species or its habitat
|
|
549
|
+
- `affinities` (multi link → phenomenon) — Phenomena associated with the species or its behavior
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
## title · family: abstract · icon: military_tech
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
### Mandate
|
|
556
|
+
|
|
557
|
+
- `authority` (text) — Rights or powers granted by the title
|
|
558
|
+
- `eligibility` (text) — Conditions or qualifications for receiving or holding the title
|
|
559
|
+
- `grant_date` (integer) — Date on which the title was granted, defined in world TIME units
|
|
560
|
+
- `revoke_date` (integer) — Date on which the title ended or was revoked, defined in world TIME units
|
|
561
|
+
- `issuer` (single link → institution) — Institution that formally created or granted the title
|
|
562
|
+
- `body` (single link → institution) — Institution in which the title functions or holds relevance
|
|
563
|
+
- `superior_title` (single link → title) — Another title that has authority over this one
|
|
564
|
+
- `holders` (multi link → character) — Characters who currently hold or represent the title
|
|
565
|
+
- `symbols` (multi link → object) — Objects that symbolize or authorize the title
|
|
566
|
+
|
|
567
|
+
### World
|
|
568
|
+
|
|
569
|
+
- `status` (text) — Current state or general condition of the title
|
|
570
|
+
- `history` (text) — Background information on the title's origin, evolution, or significance
|
|
571
|
+
- `characters` (multi link → character) — Characters otherwise relevant to the title
|
|
572
|
+
- `institutions` (multi link → institution) — Institutions relevant to the title
|
|
573
|
+
- `families` (multi link → family) — Families relevant to the title
|
|
574
|
+
- `zones` (multi link → zone) — Zones relevant to the title
|
|
575
|
+
- `locations` (multi link → location) — Locations relevant to the title
|
|
576
|
+
- `objects` (multi link → object) — Objects otherwise relevant to the title
|
|
577
|
+
- `constructs` (multi link → construct) — Constructs relevant to the title
|
|
578
|
+
- `laws` (multi link → law) — Laws relevant to the title
|
|
579
|
+
- `collectives` (multi link → collective) — Collectives relevant to the title
|
|
580
|
+
- `creatures` (multi link → creature) — Creatures relevant to the title
|
|
581
|
+
- `phenomena` (multi link → phenomenon) — Phenomena relevant to the title
|
|
582
|
+
- `species` (multi link → species) — Species relevant to the title
|
|
583
|
+
- `languages` (multi link → language) — Languages relevant to the title
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
## trait · family: abstract · icon: flaky
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
### Qualitative
|
|
590
|
+
|
|
591
|
+
- `social_effects` (text) — Relating to social relationships, reputation, or interaction dynamics
|
|
592
|
+
- `physical_effects` (text) — Relating to physical changes, limitations, or enhancements
|
|
593
|
+
- `functional_effects` (text) — Relating to practical or learned performance or aptitude
|
|
594
|
+
- `personality_effects` (text) — Relating to temperament, mental state, or personality expression
|
|
595
|
+
- `behaviour_effects` (text) — Relating to visible aspects and patterns of behavior
|
|
596
|
+
|
|
597
|
+
### Quantitative
|
|
598
|
+
|
|
599
|
+
- `charisma` (integer) — Affecting a character's charisma score
|
|
600
|
+
- `coercion` (integer) — Affecting a character's coercion score
|
|
601
|
+
- `competence` (integer) — Affecting a character's competence score
|
|
602
|
+
- `compassion` (integer) — Affecting a character's compassion score
|
|
603
|
+
- `creativity` (integer) — Affecting a character's creativity score
|
|
604
|
+
- `courage` (integer) — Affecting a character's courage score
|
|
605
|
+
|
|
606
|
+
### World
|
|
607
|
+
|
|
608
|
+
- `significance` (text) — Describes the trait's societal, symbolic, or systemic presence
|
|
609
|
+
- `anti_trait` (single link → trait) — Opposing trait that contradicts or nullifies the trait
|
|
610
|
+
- `empowered_abilities` (multi link → ability) — Abilities strengthened or enabled by the trait
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
## zone · family: world · icon: architecture
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
### Scope
|
|
617
|
+
|
|
618
|
+
- `role` (text) — The operational function or intent of the zone
|
|
619
|
+
- `start_date` (integer) — Date when the zone becomes extant or relevant, defined in world TIME units
|
|
620
|
+
- `end_date` (integer) — Date when the zone ceases to be meaningful or enforced, defined in world TIME units
|
|
621
|
+
- `phenomena` (multi link → phenomenon) — Phenomena that affect, define, or occur within the zone
|
|
622
|
+
- `linked_zones` (multi link → zone) — Other zones that are associated with the zone
|
|
623
|
+
|
|
624
|
+
### World
|
|
625
|
+
|
|
626
|
+
- `context` (text) — Historical and key knowledge about the zone
|
|
627
|
+
- `populations` (multi link → collective) — Distinct collective groups or communities residing within the zone
|
|
628
|
+
- `titles` (multi link → title) — Titles assigned to represent, manage, or protect the zone
|
|
629
|
+
- `principles` (multi link → construct) — Influential mechanics acted within, upon, or by the zone
|
|
630
|
+
|