Skip to main content

rayengine/
lib.rs

1#![doc = include_str!("../README.md")]
2
3pub use rayengine_core as core;
4pub use rayengine_core::first_person;
5pub use rayengine_core::save;
6pub use raylib;
7
8pub mod assets;
9pub mod diagnostics;
10pub mod input;
11pub mod material;
12pub mod plugin;
13pub mod render;
14pub mod runtime;
15pub mod upload;
16
17pub use plugin::Plugin;
18pub use runtime::{
19    App, Config, CursorMode, Error, Game, InitContext, RunOptions, RunReport, Update,
20};
21
22/// Guides authored in Markdown and exported to HTML by rustdoc.
23pub mod guides {
24    #[doc = include_str!("../docs/quickstart.md")]
25    pub mod quickstart {}
26    #[doc = include_str!("../docs/game_structure.md")]
27    pub mod game_structure {}
28    #[doc = include_str!("../docs/plugins.md")]
29    pub mod plugins {}
30    #[doc = include_str!("../docs/responsive.md")]
31    pub mod responsive {}
32    #[doc = include_str!("../docs/timing_input.md")]
33    pub mod timing_input {}
34    #[doc = include_str!("../docs/first_person.md")]
35    #[doc = "\n\n```no_run"]
36    #[doc = include_str!("../examples/first_person.rs")]
37    #[doc = "```"]
38    pub mod first_person {}
39    #[doc = include_str!("../docs/assets.md")]
40    pub mod assets {}
41    #[doc = include_str!("../docs/generated_meshes.md")]
42    pub mod generated_meshes {}
43    #[doc = include_str!("../docs/materials.md")]
44    pub mod materials {}
45    #[doc = include_str!("../docs/spatial_queries.md")]
46    pub mod spatial_queries {}
47    #[doc = include_str!("../docs/background_work.md")]
48    pub mod background_work {}
49    #[doc = include_str!("../docs/interactive_ui.md")]
50    #[doc = "\n\n```no_run"]
51    #[doc = include_str!("../examples/menu.rs")]
52    #[doc = "```"]
53    pub mod interactive_ui {}
54    #[doc = include_str!("../docs/saves.md")]
55    #[doc = "\n\n```no_run"]
56    #[doc = include_str!("../examples/save.rs")]
57    #[doc = "```"]
58    pub mod saves {}
59    #[doc = include_str!("../docs/diagnostics.md")]
60    pub mod diagnostics {}
61    #[doc = include_str!("../docs/testing_performance.md")]
62    pub mod testing_performance {}
63    #[doc = include_str!("../docs/agent_workflow.md")]
64    pub mod agent_workflow {}
65}
66
67/// Common imports for a game using the prescribed lifecycle.
68pub mod prelude {
69    pub use crate::assets::{MaterialId, MeshId, ModelId, ShaderId, SoundId, TextureId};
70    pub use crate::input::{Bindings, Button};
71    pub use crate::material::{AlphaMode, MaterialDesc, MaterialParam, UniformId, UniformValue};
72    pub use crate::render::{Frame, UiButtonStyle};
73    pub use crate::upload::{
74        MeshUpload, MeshUploadOutcome, MeshUploadQueue, MeshUploadResult, MeshUploadTarget,
75        UploadBudget, UploadReport,
76    };
77    pub use crate::{
78        App, Config, CursorMode, Error, Game, InitContext, Plugin, RunOptions, Update,
79    };
80    pub use rayengine_core::prelude::*;
81    pub use raylib::prelude::{Color, KeyboardKey};
82}