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//! * [`lookup`] — canonical name lookup: display names, near spellings, and
15//! settings paths resolve to the accepted catalog and settings vocabulary;
16//! * [`actions`], [`events`], [`rules`], [`values`], [`settings`], and
17//! [`gameplay`] — the discoverable Workshop domains;
18//! * [`program`] — the canonical public Workshop program model;
19//! * [`parser`], [`validate`], [`convert`], [`roundtrip`], and [`emitter`] —
20//! the public Workshop operations over that model;
21//!
22//! The catalog is locale-independent at the identity layer: analyzer and
23//! APIs never need locale-specific strings to identify a builtin. Locale
24//! coverage is data, declared in the catalog dataset
25//! ([`catalog::Catalog`], [`docs/adr/0001-catalog-boundaries.md`](https://github.com/wrightkit/workshop-rs/blob/main/docs/adr/0001-catalog-boundaries.md)).
26
27pub mod actions;
28mod analysis;
29pub mod catalog;
30pub mod convert;
31mod core;
32pub mod detect;
33pub mod emitter;
34mod error;
35pub mod events;
36pub mod format;
37mod frontend;
38pub mod gameplay;
39pub mod lookup;
40mod output;
41pub mod parser;
42pub mod program;
43pub mod roundtrip;
44pub mod rules;
45pub mod settings;
46pub mod signatures;
47pub mod source;
48pub mod validate;
49pub mod values;
50pub(crate) mod wir;
51
52pub use error::{CatalogError, WorkshopError};
53pub use program::{
54 Action, Condition, Event, EventTarget, EventTeam, MappedText, ModifyOp, PlayerEventKind,
55 Program, Rule, SourceMap, SourceMapError, SourceMappingError, Subroutine, Value, Variable,
56};
57
58#[cfg(test)]
59extern crate self as workshop_rs;
60
61#[cfg(test)]
62mod tests;