Skip to content

Commit

Permalink
Rename headless_defaults example to no_renderer for clarity (bevy…
Browse files Browse the repository at this point in the history
…engine#5263)

# Objective

- Reduce confusion as the example opens a window and isn't truly "headless"
- Fixes bevyengine#5260.


## Solution

- Rename the example and add to the docs that the window is expected.
  • Loading branch information
LegNeato authored and inodentry committed Aug 8, 2022
1 parent 831d82f commit 292388f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
File renamed without changes.
10 changes: 5 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -594,12 +594,12 @@ category = "Application"
wasm = false

[[example]]
name = "headless_defaults"
path = "examples/app/headless_defaults.rs"
name = "no_renderer"
path = "examples/app/no_renderer.rs"

[package.metadata.example.headless_defaults]
name = "Headless with Defaults"
description = "An application that runs with default plugins, but without an actual renderer"
[package.metadata.example.no_renderer]
name = "No Renderer"
description = "An application that runs with default plugins and displays an empty window, but without an actual renderer"
category = "Application"
wasm = false

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ Example | Description
[Empty](../examples/app/empty.rs) | An empty application (does nothing)
[Empty with Defaults](../examples/app/empty_defaults.rs) | An empty application with default plugins
[Headless](../examples/app/headless.rs) | An application that runs without default plugins
[Headless with Defaults](../examples/app/headless_defaults.rs) | An application that runs with default plugins, but without an actual renderer
[Logs](../examples/app/logs.rs) | Illustrate how to use generate log output
[No Renderer](../examples/app/no_renderer.rs) | An application that runs with default plugins and displays an empty window, but without an actual renderer
[Plugin](../examples/app/plugin.rs) | Demonstrates the creation and registration of a custom plugin
[Plugin Group](../examples/app/plugin_group.rs) | Demonstrates the creation and registration of a custom plugin group
[Return after Run](../examples/app/return_after_run.rs) | Show how to return to main after the Bevy app has exited
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
//! An application that runs with default plugins, but without an actual renderer.
//! An application that runs with default plugins and displays an empty
//! window, but without an actual renderer.
//! This can be very useful for integration tests or CI.
//!
//! See also the `headless` example which does not display a window.
use bevy::{prelude::*, render::settings::WgpuSettings};

Expand Down

0 comments on commit 292388f

Please sign in to comment.