Skip to content

Commit

Permalink
Add warning about upcoming changes to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jondolf authored Mar 5, 2024
1 parent 3fb7ad5 commit e9b98d0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@
**Bevy XPBD** is a 2D and 3D physics engine based on _Extended Position Based Dynamics_ (XPBD)
for the [Bevy game engine](https://bevyengine.org/).

---

## Warning ⚠️

Bevy XPBD will undergo major changes and a rebrand during April or May.

The XPBD simulation method has several potential issues, one being that it is technically patented by NVIDIA,
and is therefore dicey to distribute in projects. We will transition away from the simulation method
and rename the crate when we have a replacement implemented.

If you are working on a project that uses Bevy XPBD, don't worry, you may continue using it.
Just be aware of the patent, as it is technically up to the user to have the rights to distribute
XPBD in projects. This will be addressed by the rebrand.

You can find a much more in-depth explanation of the situation and plans
[here](https://github.com/Jondolf/bevy_xpbd/issues/346).

---

## Design

Below are some of the core design principles used in Bevy XPBD.
Expand Down

0 comments on commit e9b98d0

Please sign in to comment.