-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Disable system stepping feature by default #11931
Comments
Is disabled really the better default tho? Release builds are the exception not debug builds. |
Disabling features of your dependencies in Rust is particularly painful: if it's not on the core path I'd prefer to keep it out. In particular, when building my games I like to have a |
# Objective Fix #11931 ## Solution - Make stepping a non-default feature - Adjust documentation and examples - In particular, make the breakout example not show the stepping prompt if compiled without the feature (shows a log message instead) --- ## Changelog - Removed `bevy_debug_stepping` from default features ## Migration Guide The system-by-system stepping feature is now disabled by default; to use it, enable the `bevy_debug_stepping` feature explicitly: ```toml [dependencies] bevy = { version = "0.14", features = ["bevy_debug_stepping"] } ``` Code using [`Stepping`](https://docs.rs/bevy/latest/bevy/ecs/schedule/struct.Stepping.html) will still compile with the feature disabled, but will print a runtime error message to the console if the application attempts to enable stepping. --------- Co-authored-by: James Liu <[email protected]> Co-authored-by: François Mockers <[email protected]>
# Objective Fix bevyengine#11931 ## Solution - Make stepping a non-default feature - Adjust documentation and examples - In particular, make the breakout example not show the stepping prompt if compiled without the feature (shows a log message instead) --- ## Changelog - Removed `bevy_debug_stepping` from default features ## Migration Guide The system-by-system stepping feature is now disabled by default; to use it, enable the `bevy_debug_stepping` feature explicitly: ```toml [dependencies] bevy = { version = "0.14", features = ["bevy_debug_stepping"] } ``` Code using [`Stepping`](https://docs.rs/bevy/latest/bevy/ecs/schedule/struct.Stepping.html) will still compile with the feature disabled, but will print a runtime error message to the console if the application attempts to enable stepping. --------- Co-authored-by: James Liu <[email protected]> Co-authored-by: François Mockers <[email protected]>
What problem does this solve or what need does it fill?
This feature should not be included in shipped games, and adds small but measurable performance overhead to running schedules.
What solution would you like?
Disable the feature by default, and document that you need to enable it in the example.
What alternative(s) have you considered?
Add this to your
Cargo.toml
, and update it every release:Additional context
Any other information you would like to add such as related previous work,
screenshots, benchmarks, etc.
The text was updated successfully, but these errors were encountered: