Skip to main content

openstranded_common/
lib.rs

1//! # openstranded-common
2//!
3//! Meta-crate for all `openstranded-common-*` data types.
4//!
5//! Re-exports every public type from every `openstranded-common-{domain}`
6//! crate, so that consumers can add a single dependency and get everything.
7//!
8//! ## Usage
9//!
10//! ```toml
11//! [dependencies]
12//! openstranded-common = "0.1"
13//! ```
14//!
15//! ```ignore
16//! use openstranded_common::*;
17//!
18//! let item = ItemDef::from_inf_fields(&fields);
19//! let recipe = RecipeDef::from_combi_fields(1, &combi_fields);
20//! let building = BuildingDef::from_inf_fields(&fields);
21//! let survival = SurvivalParams::from_inf_fields(&fields);
22//! let object = ObjectDef::from_inf_fields(&fields);
23//! let unit = UnitDef::from_inf_fields(&fields);
24//! ```
25//!
26//! ## Included domains
27//!
28//! | Module | Primary types |
29//! |--------|--------------|
30//! | [`openstranded_common_items`] | `ItemDef`, `ItemStack`, `ItemGroup`, `Material` |
31//! | [`openstranded_common_crafting`] | `RecipeDef`, `RecipeRequirement`, `RecipeResult` |
32//! | [`openstranded_common_building`] | `BuildingDef`, `BuildingGroup`, `BuildSpace`, `BuildingRequirement` |
33//! | [`openstranded_common_survival`] | `SurvivalParams`, `HealthSystem`, `ExhaustRate`, `DiveParams`, `JumpParams` |
34//! | [`openstranded_common_objects`] | `ObjectDef`, `CollisionMode`, `SpawnDef`, `HarvestDef`, `ObjectScale` |
35//! | [`openstranded_common_units`] | `UnitDef`, `AnimFrame`, `LootEntry`, `VehicleParams`, `UnitAnimations` |
36//!
37//! ## Dependency
38//!
39//! Only `serde` (transitively). This is a pure data crate set with no
40//! engine or WASM runtime dependencies.
41
42pub use openstranded_common_building::*;
43pub use openstranded_common_crafting::*;
44pub use openstranded_common_items::*;
45pub use openstranded_common_objects::*;
46pub use openstranded_common_survival::*;
47pub use openstranded_common_units::*;