delvewright_dsl/
lib.rs

1//! Delvewright DSL: serde types, validation, canonical serialization and JSON
2//! Schema export for the staged campaign DSL (spec-0001).
3//!
4//! Entry points:
5//! - [`parse_campaign`] / [`check_campaign`]: parse the six raw stage documents.
6//! - [`validate_campaign`]: run all spec-0001 v0.2 rule groups on a parsed
7//!   [`Campaign`], returning [`Diagnostic`]s (spec-0002 `--json` shape).
8//! - [`to_canonical_string`]: the single canonical writer — pretty JSON put
9//!   through [`fmt`], so what the compiler WRITES is what `delvec fmt --check`
10//!   accepts. One canonical form, one implementation.
11//! - [`fmt`]: that canonical form as a grammar-level formatter over any
12//!   authored JSON (stage documents, l10n sidecars, prefab metadata).
13//! - [`stage_schema`]: export a stage's JSON Schema.
14//!
15//! Determinism (ADR-0006): all iteration is over `BTreeMap`/`BTreeSet` or slices;
16//! nothing depends on hash order, wall-clock, or absolute paths.
17
18pub mod blocks;
19pub mod blockshape;
20pub mod canonical;
21pub mod chrome;
22pub mod detailplan;
23pub mod diagnostic;
24pub mod effects;
25pub mod envelope;
26pub mod fmt;
27pub mod gate;
28pub mod ids;
29pub mod l10n;
30pub mod layout;
31pub mod mclang;
32pub mod metrics;
33pub mod placement;
34pub mod prefab;
35pub mod registry;
36pub mod schema;
37pub mod siteplan;
38pub mod split;
39pub mod stages;
40pub mod validate;
41
42pub use canonical::to_canonical_string;
43pub use chrome::{Chrome, ChromeString, validate_chrome_namespace};
44pub use detailplan::{Detail, DetailPlanContent, FLOOR_COURSE, Frame, bound_places, is_bound};
45pub use diagnostic::{Diagnostic, DwCode, ExitTier, Group, Severity, Subject, codes};
46pub use effects::{
47    EffectRootKind, EffectRootOwner, EffectRootSite, RootBinding, for_each_effect_root,
48    for_each_effect_root_mut,
49};
50pub use envelope::{
51    Campaign, DSL_VERSION, Envelope, RawCampaign, Stage, check_campaign, parse_campaign,
52};
53pub use gate::{Gate, GateBinding, GateConsumer, GateSite, for_each_gate};
54pub use ids::{
55    ActorId, AmbushId, AnchorId, AreaId, BranchId, BranchPointId, CampaignId, ClassId, DatumId,
56    DialogueId, EdgeId, EditBatchId, EndingId, FactId, FlagId, LethalVolumeId, NodeId, NpcId,
57    ObjectiveId, PoolId, PrefabId, QuestId, RegionId, ShortcutId, StateId, TimedGateId, TriggerId,
58    ViewId, VolumeId, WaveId,
59};
60pub use l10n::{
61    ArtNarrate, CANONICAL_LANG, L10nDoc, L10nKind, MARKER_SIGIL, OptionLabel, ScreenNarrate,
62    SoundRef, TR_SIGIL, art_narrates, bonfire_option_labels, declared_mc_codes,
63    dialogue_option_labels, each_string, has_tr_sigil, inventory as l10n_inventory, key_speaker,
64    local_id, localize, on_screen_narrates, plain as l10n_plain, play_sound_actor_refs, sound_refs,
65    tag_translatables, untag as l10n_untag, validate_l10n, validate_l10n_provenance,
66    validate_marker_channel, validate_tr_sigil,
67};
68pub use layout::{
69    Beat, BriefFact, Closure, Direction, Edge, EdgeGating, GeometryBriefContent, Grant, Grants,
70    LayoutBinding, LayoutGraphContent, OpensFrom, Station, StationKind,
71};
72pub use mclang::mc_lang_code;
73pub use placement::{Placement, anchor_vocabulary_unknowable};
74pub use prefab::PrefabMeta;
75pub use registry::{
76    AnchorRegistry, BlockRegistry, EffectRegistry, EntityRegistry, ItemBackedBlockRegistry,
77    ItemRegistry, Lighting, LightingProfile, VendoredAnchorRegistry, VendoredEffectRegistry,
78    VendoredEntityRegistry, VendoredItemRegistry, is_potion_id, is_technical_block,
79};
80pub use schema::stage_schema;
81pub use siteplan::{
82    Axis, Ceiling, Cmp, Datum, ENTRY_ANCHOR, Face, Floor, Identity, Measure, Offset, PackedBox,
83    PlanAxis, PlanBinding, PlanBox, Provenance, SITE_AREA, Seam, Sightline, SitePlanContent, View,
84    Volume, VolumeRole, WorldBox, node_anchor, owed_anchors, placed_boxes, placed_seams,
85    placements, refused_upstream, seam_anchor, seam_unlock_anchor, synthesized_anchor_kinds,
86    synthesized_anchors, synthesized_gate_block,
87};
88pub use siteplan::{PlacedBox, PlacedSeam};
89pub use stages::{
90    Actor, Ambush, Area, AreaLighting, AreaMitigation, BONFIRE_PROMPT_EN, BONFIRE_REST_LABEL_EN,
91    BONFIRE_SAVE_LABEL_EN, BodyTraversal, BonfireLabels, Boundary, BranchDecl, BranchPoint,
92    CameraShot, CameraSubject, CameraTarget, CameraWaypoint, Carrier, CastAbsence, CastBarks,
93    CastDialogue, CastDialogueKeyword, CastEntry, CastPlace, CastPlacement, Class, ClassesContent,
94    CollectBy, CompareOp, DamageKind, DespawnStyle, DialogueContent, DialogueEffect, DialogueNode,
95    DialogueOption, EffectSite, EnchantedItem, EncounterTier, EnvTrigger, EquipItem, EquipSlot,
96    Facing, Fixture, Forfeit, Happening, HappeningVerb, Horizon, HorizonBase, HorizonSpec,
97    ItemDrop, KitItem, LethalVolume, Lethality, Locomotion, Loot, LootItem, MAX_POTION_AMPLIFIER,
98    MAX_POTION_DURATION_TICKS, MobAttributes, MobDrop, MobEffect, MobEquipment, NarrateStyle, Npc,
99    NpcDialogue, NpcSkin, NpcsContent, Objective, OnFull, Persona, Pieces, PlannedQuest,
100    PotionContents, PotionEffect, Prop, Quest, QuestEffect, QuestPlanContent, QuestsContent,
101    Relationship, Role, SequenceStep, Shop, ShopOffer, Shortcut, ShotStyle, SkinModel, SlotDrop,
102    SoundAt, Stake, StateCompare, StateDecl, StateScope, StateWrite, StealthZone, TimedGate, Trap,
103    TrapDisarm, TrapEffect, TrapReset, TrapTrigger, Trigger, TriggerAudience, TriggerOn, Wave,
104    WaveLane, WaveMob, WaveSummon, WorldContent, WorldDifficulty, WorldTime, WorldWeather,
105    is_potion_bearing_item,
106};
107pub use stages::{
108    BodyRef, BodySite, BodySkinSite, BodyTraversalSite, body_sites, body_skin_sites,
109    body_traversal_sites, for_each_campaign_effect,
110};
111pub use stages::{
112    EditBatch, EditFrame, FragmentRotation, MorphOp, PaletteBlock, PaletteRecipe, RegionShape,
113    SocketState, TreeKind, WorldEdit, WorldEditsContent,
114};
115pub use stages::{ResolvedHorizon, horizon_base, horizon_defaults, resolved_horizon};
116pub use validate::{validate_campaign, validate_campaign_with};
delvewright_dsl/lib.rs

delvewright_dsl/
lib.rs
