1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
//! Configurable skybox system for the voxel framework.
//!
//! # Modes
//!
//! Two display modes are available through [`SkyboxMode`]:
//!
//! * **`Starfield`** (default) — spawns a procedural field of unlit cube-shaped
//! stars distributed on a large sphere using a golden-angle sunflower spiral.
//! The background clear color is set to black automatically.
//! * **`Color`** — sets the Bevy [`ClearColor`] to a solid color and spawns no
//! geometry. Use this for day-sky tints or minimalist environments.
//!
//! # Render pipeline integration
//!
//! The starfield is composed of standard Bevy `Mesh3d` + `MeshMaterial3d`
//! entities marked with [`SkyboxRoot`]. All star meshes are parented to a
//! single root entity so they move with the scene. Because the star material
//! has `unlit: true`, the starfield is unaffected by scene lighting and remains
//! visible even in completely dark environments.
//!
//! For the `Color` mode, no entities are spawned; [`ClearColor`] is simply
//! overwritten as a resource during the `Startup` schedule.
//!
//! # Integration
//!
//! ```no_run
//! use bevy::prelude::*;
//! use voxel_framework::skybox::{SkyboxConfig, SkyboxMode, SkyboxPlugin, StarfieldConfig};
//!
//! fn main() {
//! App::new()
//! .insert_resource(SkyboxConfig {
//! mode: SkyboxMode::Starfield(StarfieldConfig {
//! count: 1200,
//! radius: 900.0,
//! star_size: 0.4,
//! color: Color::WHITE,
//! }),
//! })
//! .add_plugins(SkyboxPlugin)
//! .run();
//! }
//! ```
use *;
// ─── Starfield configuration ──────────────────────────────────────────────────
/// Visual parameters for the procedural starfield rendered by
/// [`SkyboxMode::Starfield`].
///
/// Stars are distributed using a golden-angle sunflower spiral on a sphere of
/// radius [`radius`](StarfieldConfig::radius). Each star is a tiny unlit cube
/// of side length [`star_size`](StarfieldConfig::star_size).
// ─── SkyboxMode ───────────────────────────────────────────────────────────────
/// Selects how the sky background is rendered.
///
/// Set this inside [`SkyboxConfig`] before adding [`SkyboxPlugin`]. Changing
/// the mode at runtime requires re-spawning the skybox manually, as the setup
/// system only runs at `Startup`.
// ─── SkyboxConfig resource ────────────────────────────────────────────────────
/// Top-level configuration resource for the skybox system.
///
/// Insert a customized instance before adding [`SkyboxPlugin`] to override the
/// default starfield, or rely on [`Default`] to get an 800-star white
/// starfield.
///
/// # Examples
///
/// ```no_run
/// use bevy::prelude::*;
/// use voxel_framework::skybox::{SkyboxConfig, SkyboxMode};
///
/// // Solid-color sky (no star geometry spawned).
/// let sky = SkyboxConfig { mode: SkyboxMode::Color(Color::srgb(0.5, 0.7, 1.0)) };
/// ```
// ─── Marker component ─────────────────────────────────────────────────────────
/// Marker component attached to the skybox root entity.
///
/// When [`SkyboxMode::Starfield`] is active, all star mesh entities are
/// parented to a single entity carrying this component. Query for `SkyboxRoot`
/// to locate or despawn the entire starfield in one operation.
;
// ─── Setup system ─────────────────────────────────────────────────────────────
/// Startup system that spawns the skybox based on [`SkyboxConfig`].
/// Spawns star entities distributed on a sphere using a golden-angle sunflower
/// spiral. Each star is a tiny unlit cube parented to a [`SkyboxRoot`] entity.
// ─── Plugin ───────────────────────────────────────────────────────────────────
/// Plugin that enables the skybox system.
///
/// # What it registers
///
/// * [`SkyboxConfig`] — initialized as a default resource (starfield with 800
/// white stars). Insert a pre-populated instance before adding this plugin
/// to override the defaults.
/// * A `Startup` system that reads [`SkyboxConfig`] and either spawns the
/// procedural starfield geometry or sets [`ClearColor`], depending on
/// [`SkyboxMode`].
///
/// # Examples
///
/// ```no_run
/// use bevy::prelude::*;
/// use voxel_framework::skybox::{SkyboxConfig, SkyboxMode, SkyboxPlugin, StarfieldConfig};
///
/// App::new()
/// .insert_resource(SkyboxConfig {
/// mode: SkyboxMode::Color(Color::srgb(0.1, 0.1, 0.2)),
/// })
/// .add_plugins(SkyboxPlugin)
/// .run();
/// ```
;
// ─── Tests ────────────────────────────────────────────────────────────────────