mirror of
https://github.com/bevyengine/bevy
synced 2024-11-30 08:30:24 +00:00
e167a1d9cf
This relicenses Bevy under the dual MIT or Apache-2.0 license. For rationale, see #2373. * Changes the LICENSE file to describe the dual license. Moved the MIT license to docs/LICENSE-MIT. Added the Apache-2.0 license to docs/LICENSE-APACHE. I opted for this approach over dumping both license files at the root (the more common approach) for a number of reasons: * Github links to the "first" license file (LICENSE-APACHE) in its license links (you can see this in the wgpu and rust-analyzer repos). People clicking these links might erroneously think that the apache license is the only option. Rust and Amethyst both use COPYRIGHT or COPYING files to solve this problem, but this creates more file noise (if you do everything at the root) and the naming feels way less intuitive. * People have a reflex to look for a LICENSE file. By providing a single license file at the root, we make it easy for them to understand our licensing approach. * I like keeping the root clean and noise free * There is precedent for putting the apache and mit license text in sub folders (amethyst) * Removed the `Copyright (c) 2020 Carter Anderson` copyright notice from the MIT license. I don't care about this attribution, it might make license compliance more difficult in some cases, and it didn't properly attribute other contributors. We shoudn't replace it with something like "Copyright (c) 2021 Bevy Contributors" because "Bevy Contributors" is not a legal entity. Instead, we just won't include the copyright line (which has precedent ... Rust also uses this approach). * Updates crates to use the new "MIT OR Apache-2.0" license value * Removes the old legion-transform license file from bevy_transform. bevy_transform has been its own, fully custom implementation for a long time and that license no longer applies. * Added a License section to the main readme * Updated our Bevy Plugin licensing guidelines. As a follow-up we should update the website to properly describe the new license. Closes #2373
113 lines
6.7 KiB
Markdown
113 lines
6.7 KiB
Markdown
# [](https://bevyengine.org)
|
|
|
|
[](https://crates.io/crates/bevy)
|
|
[](./LICENSE)
|
|
[](https://crates.io/crates/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 _very_ early stages of development. APIs can and will change (now is the time to make suggestions!). Important features are missing. Documentation is sparse. Please don't build any serious projects in Bevy unless you are prepared to be broken by API changes constantly.
|
|
|
|
## 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.
|
|
* **[Roadmap](https://github.com/bevyengine/bevy/projects/1):** The Bevy team's development plan.
|
|
* **[Introducing Bevy](https://bevyengine.org/news/introducing-bevy/)**: A blog post covering some of Bevy's 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.
|
|
* **[Community-Made Learning Resources](https://github.com/bevyengine/awesome-bevy#learning)**: 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)** and
|
|
**[How to Contribute](https://bevyengine.org/learn/book/contributing/code/)**
|
|
|
|
* **[Discord](https://discord.gg/bevy):** Bevy's official discord server.
|
|
* **[Reddit](https://reddit.com/r/bevy):** Bevy's official subreddit.
|
|
* **[Stack Overflow](https://stackoverflow.com/questions/tagged/bevy):** Questions tagged Bevy on Stack Overflow.
|
|
* **[Awesome Bevy](https://github.com/bevyengine/awesome-bevy):** A collection of awesome Bevy projects.
|
|
|
|
## 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
|
|
```
|
|
|
|
### 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/).
|
|
|
|
## Focus Areas
|
|
|
|
Bevy has the following [Focus Areas](https://github.com/bevyengine/bevy/labels/focus-area). We are currently focusing our development efforts in these areas, and they will receive priority for Bevy developers' time. If you would like to contribute to Bevy, you are heavily encouraged to join in on these efforts:
|
|
|
|
### [Editor-Ready UI](https://github.com/bevyengine/bevy/issues/254)
|
|
|
|
### [PBR / Clustered Forward Rendering](https://github.com/bevyengine/bevy/issues/179)
|
|
|
|
### [Scenes](https://github.com/bevyengine/bevy/issues/255)
|
|
|
|
## Libraries Used
|
|
|
|
Bevy is only possible because of the hard work put into these foundational technologies:
|
|
|
|
* [wgpu](https://wgpu.rs/): modern / low-level / cross-platform graphics library inspired by Vulkan
|
|
* [glam-rs](https://github.com/bitshifter/glam-rs): a simple and fast 3D math library for games and graphics
|
|
* [winit](https://github.com/rust-windowing/winit): cross-platform window creation and management in Rust
|
|
* [spirv-reflect](https://github.com/gwihlidal/spirv-reflect-rs): Reflection API in rust for SPIR-V shader byte code
|
|
|
|
## [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 and Alternatives
|
|
|
|
Additionally, we would like to thank the [Amethyst](https://github.com/amethyst/amethyst), [macroquad](https://github.com/not-fl3/macroquad), [coffee](https://github.com/hecrj/coffee), [ggez](https://github.com/ggez/ggez), [rg3d](https://github.com/mrDIMAS/rg3d), and [Piston](https://github.com/PistonDevelopers/piston) projects for providing solid examples of game engine development in Rust. If you are looking for a Rust game engine, it is worth considering all of your options. Each engine has different design goals, and some will likely resonate with you more than others.
|
|
|
|
## License
|
|
|
|
Bevy is free and open source! All code in this repository is dual-licensed under either:
|
|
|
|
* MIT License ([LICENSE-MIT](docs/LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
|
|
* Apache License, Version 2.0 ([LICENSE-APACHE](docs/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.
|
|
|
|
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.
|