Skip to main content

voxel_framework/
plugin_category.rs

1//! Official plugin category marker traits.
2//!
3//! `voxel-framework` exposes a flat catalog of Bevy plugins. These marker
4//! traits document each plugin's primary architectural responsibility without
5//! changing Bevy's normal [`Plugin`] composition model.
6//!
7//! A plugin should normally belong to exactly one category:
8//!
9//! - [`EnginePlugin`] — foundation for streamable/renderable voxel worlds.
10//! - [`WorldDataPlugin`] — chunk sources, generation, persistence, and world
11//!   lifecycle data.
12//! - [`GameplayPlugin`] — reusable game rules and interactions.
13//! - [`DefaultImplementationPlugin`] — replaceable UI/audio/visual defaults.
14//! - [`ConveniencePlugin`] — compatibility bundles, input adapters, recipes,
15//!   and prototyping helpers.
16//!
17//! New domain behavior should not start as [`ConveniencePlugin`]. Convenience
18//! plugins should compose or adapt plugins from the stricter categories.
19
20use bevy::app::Plugin;
21
22use crate::audio::{DefaultAudioPlugin, SfxPlugin};
23use crate::content::VoxelContentPlugin;
24#[cfg(feature = "items")]
25use crate::content::{BlockDropContentPlugin, ItemContentPlugin};
26#[cfg(feature = "crafting")]
27use crate::crafting::{CraftingPlugin, CraftingUiPlugin};
28use crate::fragments::FragmentPlugin;
29use crate::generator::{GeneratorPlugin, MultiGeneratorPlugin};
30#[cfg(feature = "items")]
31use crate::items::{DropsPlugin, HotbarPlugin, ItemType};
32use crate::mesh::MeshPlugin;
33#[cfg(feature = "mobs")]
34use crate::mobs::MobPlugin;
35use crate::player::PlayerPlugin;
36use crate::player::effects::{StatusEffect, StatusEffectsPlugin};
37use crate::render::RenderPlugin;
38use crate::skybox::SkyboxPlugin;
39use crate::stats::VoxelStatsPlugin;
40use crate::ui::{
41    CrosshairPlugin, DebugOverlayPlugin, LoadingScreenPlugin, PauseMenuPlugin, UiPlugin,
42};
43#[cfg(feature = "items")]
44use crate::ui::{HotbarUiPlugin, PickupNotificationPlugin};
45use crate::voxel::VoxelType;
46#[cfg(feature = "crafting")]
47use crate::world::manifest::WorldManifestPlugin;
48use crate::world::mining::MiningPlugin;
49use crate::world::{
50    DayCyclePlugin, LoadingPlugin, OcclusionPlugin, PersistencePlugin, PlacementPlugin,
51    WorldConfigPlugin, WorldPlugin,
52};
53#[cfg(feature = "items")]
54use crate::world::{MiningInputPlugin, PlacementInputPlugin};
55
56/// Marker for plugins that are part of the `voxel-framework` plugin catalog.
57pub trait VoxelFrameworkPlugin: Plugin {}
58
59/// Foundation/infrastructure plugins for streamable, renderable voxel worlds.
60pub trait EnginePlugin: VoxelFrameworkPlugin {}
61
62/// Chunk source, generation, persistence, and world lifecycle data plugins.
63pub trait WorldDataPlugin: VoxelFrameworkPlugin {}
64
65/// Reusable game rules and interaction plugins.
66pub trait GameplayPlugin: VoxelFrameworkPlugin {}
67
68/// Replaceable UI, audio, visual, and presentation default plugins.
69pub trait DefaultImplementationPlugin: VoxelFrameworkPlugin {}
70
71/// Exceptional compatibility, bundle, input-adapter, recipe, or prototype helper plugins.
72pub trait ConveniencePlugin: VoxelFrameworkPlugin {}
73
74impl VoxelFrameworkPlugin for WorldPlugin {}
75impl EnginePlugin for WorldPlugin {}
76
77impl VoxelFrameworkPlugin for WorldConfigPlugin {}
78impl EnginePlugin for WorldConfigPlugin {}
79
80impl<V: VoxelType> VoxelFrameworkPlugin for RenderPlugin<V> {}
81impl<V: VoxelType> EnginePlugin for RenderPlugin<V> {}
82
83impl<V: VoxelType> VoxelFrameworkPlugin for MeshPlugin<V> {}
84impl<V: VoxelType> EnginePlugin for MeshPlugin<V> {}
85
86impl<V: VoxelType> VoxelFrameworkPlugin for OcclusionPlugin<V> {}
87impl<V: VoxelType> EnginePlugin for OcclusionPlugin<V> {}
88
89impl VoxelFrameworkPlugin for LoadingPlugin {}
90impl EnginePlugin for LoadingPlugin {}
91
92impl<V: VoxelType> VoxelFrameworkPlugin for GeneratorPlugin<V> {}
93impl<V: VoxelType> WorldDataPlugin for GeneratorPlugin<V> {}
94
95impl<V: VoxelType> VoxelFrameworkPlugin for MultiGeneratorPlugin<V> {}
96impl<V: VoxelType> WorldDataPlugin for MultiGeneratorPlugin<V> {}
97
98impl<V: VoxelType> VoxelFrameworkPlugin for PersistencePlugin<V> {}
99impl<V: VoxelType> WorldDataPlugin for PersistencePlugin<V> {}
100
101impl<V: VoxelType> VoxelFrameworkPlugin for VoxelContentPlugin<V> {}
102impl<V: VoxelType> GameplayPlugin for VoxelContentPlugin<V> {}
103
104impl VoxelFrameworkPlugin for VoxelStatsPlugin {}
105impl GameplayPlugin for VoxelStatsPlugin {}
106
107#[cfg(feature = "items")]
108impl<I: ItemType> VoxelFrameworkPlugin for ItemContentPlugin<I> {}
109#[cfg(feature = "items")]
110impl<I: ItemType> GameplayPlugin for ItemContentPlugin<I> {}
111
112#[cfg(feature = "items")]
113impl<I: ItemType> VoxelFrameworkPlugin for BlockDropContentPlugin<I> {}
114#[cfg(feature = "items")]
115impl<I: ItemType> GameplayPlugin for BlockDropContentPlugin<I> {}
116
117#[cfg(feature = "crafting")]
118impl<V: VoxelType, I: ItemType> VoxelFrameworkPlugin for WorldManifestPlugin<V, I> {}
119#[cfg(feature = "crafting")]
120impl<V: VoxelType, I: ItemType> WorldDataPlugin for WorldManifestPlugin<V, I> {}
121
122impl VoxelFrameworkPlugin for MiningPlugin {}
123impl GameplayPlugin for MiningPlugin {}
124
125impl VoxelFrameworkPlugin for PlacementPlugin {}
126impl GameplayPlugin for PlacementPlugin {}
127
128impl<V: VoxelType> VoxelFrameworkPlugin for PlayerPlugin<V> {}
129impl<V: VoxelType> GameplayPlugin for PlayerPlugin<V> {}
130
131#[cfg(feature = "items")]
132impl VoxelFrameworkPlugin for HotbarPlugin {}
133#[cfg(feature = "items")]
134impl GameplayPlugin for HotbarPlugin {}
135
136#[cfg(feature = "items")]
137impl<I: ItemType> VoxelFrameworkPlugin for DropsPlugin<I> {}
138#[cfg(feature = "items")]
139impl<I: ItemType> GameplayPlugin for DropsPlugin<I> {}
140
141#[cfg(feature = "crafting")]
142impl<I: ItemType> VoxelFrameworkPlugin for CraftingPlugin<I> {}
143#[cfg(feature = "crafting")]
144impl<I: ItemType> GameplayPlugin for CraftingPlugin<I> {}
145
146#[cfg(feature = "mobs")]
147impl<V: VoxelType> VoxelFrameworkPlugin for MobPlugin<V> {}
148#[cfg(feature = "mobs")]
149impl<V: VoxelType> GameplayPlugin for MobPlugin<V> {}
150
151impl<E: StatusEffect> VoxelFrameworkPlugin for StatusEffectsPlugin<E> {}
152impl<E: StatusEffect> GameplayPlugin for StatusEffectsPlugin<E> {}
153
154impl VoxelFrameworkPlugin for FragmentPlugin {}
155impl DefaultImplementationPlugin for FragmentPlugin {}
156
157impl VoxelFrameworkPlugin for SkyboxPlugin {}
158impl DefaultImplementationPlugin for SkyboxPlugin {}
159
160impl VoxelFrameworkPlugin for SfxPlugin {}
161impl DefaultImplementationPlugin for SfxPlugin {}
162
163impl VoxelFrameworkPlugin for DefaultAudioPlugin {}
164impl DefaultImplementationPlugin for DefaultAudioPlugin {}
165
166impl VoxelFrameworkPlugin for UiPlugin {}
167impl DefaultImplementationPlugin for UiPlugin {}
168
169impl VoxelFrameworkPlugin for CrosshairPlugin {}
170impl DefaultImplementationPlugin for CrosshairPlugin {}
171
172impl VoxelFrameworkPlugin for LoadingScreenPlugin {}
173impl DefaultImplementationPlugin for LoadingScreenPlugin {}
174
175#[cfg(feature = "items")]
176impl VoxelFrameworkPlugin for HotbarUiPlugin {}
177#[cfg(feature = "items")]
178impl DefaultImplementationPlugin for HotbarUiPlugin {}
179
180#[cfg(feature = "items")]
181impl<I: ItemType> VoxelFrameworkPlugin for PickupNotificationPlugin<I> {}
182#[cfg(feature = "items")]
183impl<I: ItemType> DefaultImplementationPlugin for PickupNotificationPlugin<I> {}
184
185impl VoxelFrameworkPlugin for PauseMenuPlugin {}
186impl DefaultImplementationPlugin for PauseMenuPlugin {}
187
188impl VoxelFrameworkPlugin for DebugOverlayPlugin {}
189impl DefaultImplementationPlugin for DebugOverlayPlugin {}
190
191impl VoxelFrameworkPlugin for DayCyclePlugin {}
192impl DefaultImplementationPlugin for DayCyclePlugin {}
193
194impl<V: VoxelType> VoxelFrameworkPlugin for crate::VoxelCorePlugin<V> {}
195impl<V: VoxelType> ConveniencePlugin for crate::VoxelCorePlugin<V> {}
196
197impl<V: VoxelType> VoxelFrameworkPlugin for crate::VoxelPlugin<V> {}
198impl<V: VoxelType> ConveniencePlugin for crate::VoxelPlugin<V> {}
199
200#[cfg(feature = "items")]
201impl<V: VoxelType, I: ItemType> VoxelFrameworkPlugin for MiningInputPlugin<V, I> {}
202#[cfg(feature = "items")]
203impl<V: VoxelType, I: ItemType> ConveniencePlugin for MiningInputPlugin<V, I> {}
204
205#[cfg(feature = "items")]
206impl<V: VoxelType> VoxelFrameworkPlugin for PlacementInputPlugin<V> {}
207#[cfg(feature = "items")]
208impl<V: VoxelType> ConveniencePlugin for PlacementInputPlugin<V> {}
209
210#[cfg(feature = "crafting")]
211impl<I: ItemType> VoxelFrameworkPlugin for CraftingUiPlugin<I> {}
212#[cfg(feature = "crafting")]
213impl<I: ItemType> ConveniencePlugin for CraftingUiPlugin<I> {}