diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..dc6317f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.1.0](https://github.com/Vrixyz/bevy_fixed_update_task/releases/tag/v0.1.0) - 2025-01-13 + +### Features + +- Custom timestep or substep count per frame. +- Component approach, support multiple concurrent fixed "task" update. +- Examples for minimal approach + interpolation integration. +- Documentation to explain how this crate works on the [readme](README.md) and [docs](./docs/). diff --git a/README.md b/README.md index 67d1825..29a4912 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ so you can improve your time budget. ## How it works +:warning: this crate makes most sense when using bevy's `multi_threaded` feature. Otherwise, this just adds unnecessary overhead. + It's quite similar to how bevy's fixed update works, but eagerly extracts ECS data into a background task, to synchronize it only when we exceed `Time` + its accumulated time. The implementation doesn't use `Time` but a component approach `TimeStep`, `SubstepCount`, `TaskToRender`.