mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 06:30:19 +00:00
2c5639e323
Bevy builds on a ton of different libraries. Choosing who gets "prime real estate" in the readme is hard / political. Closing that can of worms makes a lot of sense to me. I have also removed the "alternatives" section for similar reasons. There are a number of engines/libs that aren't credited there, some of those listed no longer exist / aren't maintained, and it isn't really our job to be the canonical source. Each alternative listed is a soft endorsement of the project (and the reverse is true for projects we don't include). Again, closing this can of worms feels like the right call.
139 lines
8 KiB
Markdown
139 lines
8 KiB
Markdown
# [](https://bevyengine.org)
|
|
|
|
[](https://github.com/bevyengine/bevy#license)
|
|
[](https://crates.io/crates/bevy)
|
|
[](https://crates.io/crates/bevy)
|
|
[](https://docs.rs/bevy/latest/bevy/)
|
|
[](https://github.com/bevyengine/bevy/actions)
|
|
[](https://discord.gg/bevy)
|
|
|
|
## What is Bevy?
|
|
|
|
Bevy is a refreshingly simple data-driven game engine built in Rust. It is free and open-source forever!
|
|
|
|
## WARNING
|
|
|
|
Bevy is still in the early stages of development. Important features are missing. Documentation is sparse. A new version of Bevy containing breaking changes to the API is released [approximately once every 3 months](https://bevyengine.org/news/bevy-0-6/#the-train-release-schedule). We provide [migration guides](https://bevyengine.org/learn/book/migration-guides/), but we can't guarantee migrations will always be easy. Use only if you are willing to work in this environment.
|
|
|
|
**MSRV:** Bevy relies heavily on improvements in the Rust language and compiler.
|
|
As a result, the Minimum Supported Rust Version (MSRV) is generally close to "the latest stable release" of Rust.
|
|
|
|
## Design Goals
|
|
|
|
* **Capable**: Offer a complete 2D and 3D feature set
|
|
* **Simple**: Easy for newbies to pick up, but infinitely flexible for power users
|
|
* **Data Focused**: Data-oriented architecture using the Entity Component System paradigm
|
|
* **Modular**: Use only what you need. Replace what you don't like
|
|
* **Fast**: App logic should run quickly, and when possible, in parallel
|
|
* **Productive**: Changes should compile quickly ... waiting isn't fun
|
|
|
|
## About
|
|
|
|
* **[Features](https://bevyengine.org):** A quick overview of Bevy's features.
|
|
* **[News](https://bevyengine.org/news/)**: A development blog that covers our progress, plans and shiny new features.
|
|
|
|
## Docs
|
|
|
|
* **[The Bevy Book](https://bevyengine.org/learn/book/introduction):** Bevy's official documentation. The best place to start learning Bevy.
|
|
* **[Bevy Rust API Docs](https://docs.rs/bevy):** Bevy's Rust API docs, which are automatically generated from the doc comments in this repo.
|
|
* **[Official Examples](https://github.com/bevyengine/bevy/tree/latest/examples):** Bevy's dedicated, runnable examples, which are great for digging into specific concepts.
|
|
* **[Community-Made Learning Resources](https://bevyengine.org/assets/#learning)**: More tutorials, documentation, and examples made by the Bevy community.
|
|
|
|
## Community
|
|
|
|
Before contributing or participating in discussions with the community, you should familiarize yourself with our [**Code of Conduct**](./CODE_OF_CONDUCT.md).
|
|
|
|
* **[Discord](https://discord.gg/bevy):** Bevy's official discord server.
|
|
* **[Reddit](https://reddit.com/r/bevy):** Bevy's official subreddit.
|
|
* **[GitHub Discussions](https://github.com/bevyengine/bevy/discussions):** The best place for questions about Bevy, answered right here!
|
|
* **[Bevy Assets](https://bevyengine.org/assets/):** A collection of awesome Bevy projects, tools, plugins and learning materials.
|
|
|
|
### Contributing
|
|
|
|
If you'd like to help build Bevy, check out the **[Contributor's Guide](https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md)**.
|
|
For simple problems, feel free to [open an issue](https://github.com/bevyengine/bevy/issues) or
|
|
[PR](https://github.com/bevyengine/bevy/pulls) and tackle it yourself!
|
|
|
|
For more complex architecture decisions and experimental mad science, please open an [RFC](https://github.com/bevyengine/rfcs) (Request For Comments) so we can brainstorm together effectively!
|
|
|
|
## Getting Started
|
|
|
|
We recommend checking out [The Bevy Book](https://bevyengine.org/learn/book/introduction) for a full tutorial.
|
|
|
|
Follow the [Setup guide](https://bevyengine.org/learn/book/getting-started/setup/) to ensure your development environment is set up correctly.
|
|
Once set up, you can quickly try out the [examples](https://github.com/bevyengine/bevy/tree/latest/examples) by cloning this repo and running the following commands:
|
|
|
|
```sh
|
|
# Switch to the correct version (latest release, default is main development branch)
|
|
git checkout latest
|
|
# Runs the "breakout" example
|
|
cargo run --example breakout
|
|
```
|
|
|
|
To draw a window with standard functionality enabled, use:
|
|
|
|
```rust
|
|
use bevy::prelude::*;
|
|
|
|
fn main(){
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.run();
|
|
}
|
|
```
|
|
|
|
### Fast Compiles
|
|
|
|
Bevy can be built just fine using default configuration on stable Rust. However for really fast iterative compiles, you should enable the "fast compiles" setup by [following the instructions here](http://bevyengine.org/learn/book/getting-started/setup/).
|
|
|
|
## [Bevy Cargo Features][cargo_features]
|
|
|
|
This [list][cargo_features] outlines the different cargo features supported by Bevy. These allow you to customize the Bevy feature set for your use-case.
|
|
|
|
[cargo_features]: docs/cargo_features.md
|
|
|
|
## [Third Party Plugins][plugin_guidelines]
|
|
|
|
Plugins are very welcome to extend Bevy's features. [Guidelines][plugin_guidelines] are available to help integration and usage.
|
|
|
|
[plugin_guidelines]: docs/plugins_guidelines.md
|
|
|
|
## Thanks
|
|
|
|
Bevy is the result of the hard work of many people. A huge thanks to all Bevy contributors, the many open source projects that have come before us, the [Rust gamedev ecosystem](https://arewegameyet.rs/), and the many libraries we build on.
|
|
|
|
A huge thanks to Bevy's [generous sponsors](https://bevyengine.org). Bevy will always be free and open source, but it isn't free to make. Please consider [sponsoring our work](https://bevyengine.org/community/donate/) if you like what we're building.
|
|
|
|
<!-- This next line need to stay exactly as is. It is required for BrowserStack sponsorship. -->
|
|
This project is tested with BrowserStack.
|
|
|
|
## License
|
|
|
|
Bevy is free, open source and permissively licensed!
|
|
Except where noted (below and/or in individual files), all code in this repository is dual-licensed under either:
|
|
|
|
* MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
|
|
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
|
|
|
|
at your option.
|
|
This means you can select the license you prefer!
|
|
This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.
|
|
|
|
Some of the engine's code carries additional copyright notices and license terms due to their external origins.
|
|
These are generally BSD-like, but exact details vary by crate:
|
|
If the README of a crate contains a 'License' header (or similar), the additional copyright notices and license terms applicable to that crate will be listed.
|
|
The above licensing requirement still applies to contributions to those crates, and sections of those crates will carry those license terms.
|
|
The [license](https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields) field of each crate will also reflect this.
|
|
For example, [`bevy_mikktspace`](./crates/bevy_mikktspace/README.md#license-agreement) has code under the Zlib license (as well as a copyright notice when choosing the MIT license).
|
|
|
|
The [assets](assets) included in this repository (for our [examples](./examples/README.md)) typically fall under different open licenses.
|
|
These will not be included in your game (unless copied in by you), and they are not distributed in the published bevy crates.
|
|
See [CREDITS.md](CREDITS.md) for the details of the licenses of those files.
|
|
|
|
### Your contributions
|
|
|
|
Unless you explicitly state otherwise,
|
|
any contribution intentionally submitted for inclusion in the work by you,
|
|
as defined in the Apache-2.0 license,
|
|
shall be dual licensed as above,
|
|
without any additional terms or conditions.
|