workshop_rs/lib.rs
1//! The canonical multi-locale Overwatch Workshop semantic core.
2//!
3//! `workshop-rs` owns the Workshop-language foundation of the WrightKit
4//! ecosystem: canonical Workshop semantics, the catalog of Workshop-defined
5//! content, the raw Workshop frontend, validation, deterministic emission,
6//! and the canonical public `Program` model. It is standalone and MIT-licensed; it has no dependency on
7//! Wright tooling crates or on any source-language provider implementation.
8//!
9//! * [`catalog`] — the canonical Workshop catalog: stable, locale-independent
10//! semantic identities, kinds, parameters, and locale tables binding
11//! identities to client spellings; catalog version/digest identity and
12//! per-locale coverage;
13//! * [`mod@format`] — canonical number formatting for computed Workshop values;
14//! * [`actions`], [`events`], [`rules`], [`values`], [`settings`], and
15//! [`gameplay`] — the discoverable Workshop domains;
16//! * [`program`] — the canonical public Workshop program model;
17//! * [`parser`], [`validate`], [`convert`], [`roundtrip`], and [`emitter`] —
18//! the public Workshop operations over that model;
19//!
20//! The catalog is locale-independent at the identity layer: analyzer and
21//! APIs never need locale-specific strings to identify a builtin. Locale
22//! coverage is data, declared in the catalog dataset
23//! ([`catalog::Catalog`], [`docs/adr/0001-catalog-boundaries.md`](https://github.com/wrightkit/workshop-rs/blob/main/docs/adr/0001-catalog-boundaries.md)).
24
25pub mod actions;
26mod analysis;
27pub mod catalog;
28pub mod convert;
29mod core;
30pub mod detect;
31pub mod emitter;
32mod error;
33pub mod events;
34pub mod format;
35mod frontend;
36pub mod gameplay;
37mod output;
38pub mod parser;
39pub mod program;
40pub mod roundtrip;
41pub mod rules;
42pub mod settings;
43pub mod signatures;
44pub mod source;
45pub mod validate;
46pub mod values;
47pub(crate) mod wir;
48
49pub use error::{CatalogError, WorkshopError};
50pub use program::{
51 Action, Condition, Event, EventTarget, EventTeam, ModifyOp, PlayerEventKind, Program,
52 ProvenanceError, Rule, Subroutine, Value, Variable,
53};
54
55#[cfg(test)]
56extern crate self as workshop_rs;
57
58#[cfg(test)]
59mod tests;