25 releases (5 breaking)
0.5.0 | May 10, 2023 |
---|---|
0.4.0-rc.2 | Mar 13, 2023 |
0.3.0 | Dec 29, 2022 |
0.2.0-rc.3 | Sep 7, 2022 |
0.0.0 | Dec 13, 2021 |
#363 in Game dev
110 downloads per month
Used in evoke
590KB
14K
SLoC
Edict
Edict is a fast and powerful ECS crate that expands traditional ECS feature set. Written in Rust by your fellow 🦀
Features
-
General purpose archetype based ECS with fast iteration.
-
Relations can be added to pair of entities, binding them together. When either of the two entities is despawned, relation is dropped.
Relation
type may further configure behavior of the bonds. -
Change tracking. Each component instance is equipped with epoch counter that tracks last potential mutation of the component. Special query type uses epoch counter to skip entities where component wasn't changed since specified epoch. Last epoch can be obtained with
World::epoch
. -
Built-in type-map for singleton values called "resources". Resources can be inserted into/fetched from
World
. Resources live separately from entities and their components. -
Runtime checks for query validity and mutable aliasing avoidance. This requires atomic operations at the beginning iteration on next archetype.
-
Support for
!Send
and!Sync
components.!Send
components cannot be fetched mutably from outside "main" thread.!Sync
components cannot be fetched immutably from outside "main" thread.World
has to be!Send
but implementsSync
. -
ActionEncoder
allows recording actions and later run them onWorld
. Actions get mutable access toWorld
. -
Component replace/drop hooks. Components can define hooks that will be executed on value drop and replace. Hooks can read old and new values,
EntityId
and can record actions intoActionEncoder
. -
Component type may define a set of types that can be borrowed from it. Borrowed type may be not sized, allowing slices, dyn traits and any other
!Sized
types. There's macro to define dyn trait borrows. Special kind of queries look into possible borrows to fetch. -
WorldBuilder
can be used to manually register component types and override default behavior. -
Optional
Component
trait to allow implicit component type registration by insertion methods. Implicit registration uses behavior defined byComponent
implementation as-is. Separate insertions methods withComponent
trait bound lifted can be used where trait is not implemented or implementation is not visible for generic type. Those methods require pre-registration of the component type. If type was not registered - method panics. Both explicit registration withWorldBuilder
and implicit registration via insertion method withComponent
type bound is enough. -
System
trait andIntoSystem
implemented for functions if argument types implementFnArg
. This way practically any system can be defined as a function. -
Scheduler
that can runSystem
s in parallel using provided executor.
no_std support
edict
can be used in no_std
environment but requires alloc
.
With "std"
feature enabled error types implement Error
trait.
"std"
feature is enabled by default and must be turned off for no_std
environment.
Dependent crates that also support no_std
should use default-features = false
for edict
dependency,
and optionally enable "std"
if needed.
License
Licensed under either of
- Apache License, Version 2.0, (license/APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (license/MIT or http://opensource.org/licenses/MIT)
at your option.
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.
Dependencies
~1.7–7.5MB
~54K SLoC