mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 06:22:01 +00:00
261905f11d
# Objective - Fixes #1800, fixes #6984 - Alternative to #7196 - Ensure feature list is always up to date and that all are documented - Help discovery of features ## Solution - Use a template to update the cargo feature list - Use the comment just above the feature declaration as the description - Add the checks to CI - Add the features to the base crate doc
21 lines
No EOL
938 B
Smarty
21 lines
No EOL
938 B
Smarty
<!-- MD041 - This file will be included in docs and should not start with a top header -->
|
|
<!-- markdownlint-disable-file MD041 -->
|
|
|
|
## Cargo Features
|
|
|
|
Bevy exposes many features to customise the engine. Enabling them add functionalities but often come at the cost of longer compilation times and extra dependencies.
|
|
|
|
### Default Features
|
|
|
|
The default feature set enables most of the expected features of a game engine, like rendering in both 2D and 3D, asset loading, audio and UI. To help reduce compilation time, consider disabling default features and enabling only those you need.
|
|
|
|
|feature name|description|
|
|
|-|-|
|
|
{% for feature in features %}{% if feature.is_default %}|{{ feature.name }}|{{ feature.description }}|
|
|
{% endif %}{% endfor %}
|
|
### Optional Features
|
|
|
|
|feature name|description|
|
|
|-|-|
|
|
{% for feature in features %}{% if feature.is_default == False %}|{{ feature.name }}|{{ feature.description }}|
|
|
{% endif %}{% endfor %} |