mirror of
https://github.com/bevyengine/bevy.git
synced 2026-05-06 06:06:42 -04:00
Terra
51fc15b1a9
# Objective - Bevy 0.17 does not have a feature named `2d`. It was introduced in 0.18. - Feel free to change the PR title if it's ambiguous or close the PR if I'm wrong. ## Solution - Update to 0.18. ## Testing - None
45 lines
2.1 KiB
Smarty
45 lines
2.1 KiB
Smarty
<!-- MD041 - This file will be included in docs and should not start with a top header -->
|
|
<!-- Use 'cargo run -p build-templated-pages -- update features' to generate this file -->
|
|
<!-- markdownlint-disable-file MD041 -->
|
|
|
|
## Cargo Features
|
|
|
|
Bevy exposes many Cargo features to customize the engine. Enabling them adds functionality but may come at the cost of longer compilation times
|
|
and extra dependencies.
|
|
|
|
### Profiles
|
|
|
|
"Profiles" are high-level groups of cargo features that provide the full Bevy experience, but scoped to a specific domain.
|
|
These exist to be paired with `default-features = false`, enabling compiling only the subset of Bevy that you need.
|
|
This can cut down compile times and shrink your final binary size.
|
|
|
|
For example, you can compile only the "2D" Bevy features (without the 3D features) like this:
|
|
|
|
```toml
|
|
bevy = { version = "0.18", default-features = false, features = ["2d"] }
|
|
```
|
|
|
|
|Profile|Description|
|
|
|-|-|
|
|
{% for feature in features %}{% if feature.is_profile %}|{{ feature.name }}|{{ feature.description }}|
|
|
{% endif %}{% endfor %}
|
|
By default, the `bevy` crate enables the {% for feature in features %}{% if feature.is_default %}`{{ feature.name }}`{% endif %}{% endfor %} features.
|
|
|
|
### Collections
|
|
|
|
"Collections" are mid-level groups of cargo features. These are used to compose the high-level "profiles". If the default profiles don't
|
|
suit your use case (ex: you want to use a custom renderer, you want to build a "headless" app, you want to target no_std, etc), then you can use these
|
|
collections to build your own "profile" equivalent, without needing to manually manage _every single_ feature.
|
|
|
|
|Collection|Description|
|
|
|-|-|
|
|
{% for feature in features %}{% if feature.is_collection %}|{{ feature.name }}|{{ feature.description }}|
|
|
{% endif %}{% endfor %}
|
|
### Feature List
|
|
|
|
This is the complete `bevy` cargo feature list, without "profiles" or "collections" (sorted by name):
|
|
|
|
|Feature|Description|
|
|
|-|-|
|
|
{% for feature in sorted_features %}{% if feature.is_collection == False and feature.is_profile == False %}|{{ feature.name }}|{{ feature.description }}|
|
|
{% endif %}{% endfor %} |