Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 2.32 KB

MIGRATIONS.md

File metadata and controls

29 lines (19 loc) · 2.32 KB
Raw

Migration Notes

Migrating from v0.2 to v0.3

As v0.3 is a breaking change to v0.2, the process to migrate over is fairly simple. The rand algorithm crates can no longer be used directly, but they can be swapped wholesale with bevy_prng instead. So the following Cargo.toml changes:

- rand_chacha = { version = "0.3", features = ["serde1"] }
+ bevy_prng = { version = "0.1", features = ["rand_chacha"] }

allows then you to swap your import like so, which should then plug straight into existing bevy_rand usage seamlessly:

use bevy::prelude::*;
use bevy_rand::prelude::*;
- use rand_chacha::ChaCha8Rng;
+ use bevy_prng::ChaCha8Rng;

This will change the type path and the serialization format for the PRNGs, but currently, moving between different bevy versions has this problem as well as there's currently no means to migrate serialized formats from one version to another yet. The rationale for this change is to enable stable TypePath that is being imposed by bevy's reflection system, so that future compiler changes won't break things unexpectedly as std::any::type_name has no stability guarantees. Going forward, this should resolve any stability problems bevy_rand might have and be able to hook into any migration tool bevy might offer for when scene formats change/update.

Migrating from v0.5 to v0.6

As the wyrand dependency has been updated and contains a breaking output change, users of bevy_rand making use of the wyrand feature will need to update their code in cases where deterministic output from the old version is expected. The new WyRand output is considered to provide better entropy than the old version, so it is recommended to adopt the new version. In reality, this is likely to affect tests and serialised output rather than game code.

Migrating from v0.7 to v0.8

GlobalRngSeed has been removed, instead being rolled into GlobalEntropy. This will allow better reflection tracking of the global rng source, and will allow for automatic reseeding without any custom system needing to be provided. Use the reseed method to reinstantiate the internal RNG source with the new seed, and get_seed to return a reference to the initial starting seed for the source. The serialized format of GlobalEntropy has changed and previously serialized instances are no longer compatible.