flecs

A fast entity component system (ECS) for C & C++

MIT License

Stars
5.5K

Bot releases are hidden (Show)

flecs - Flecs v4.0.2-alpha Latest Release

Published by SanderMertens 6 months ago

What is this?

This is another early preview of the upcoming v4 release! 🎉

You can use this release to familiarize and play around with the new APIs and features before v4 comes out. The biggest difference between v3 and v4 is a new query engine that unifies filters, queries and rules in a single API.

What's new since v4.0.1-alpha

  • A new Flecs Script parser with an improved syntax, new features and a new script manual!
  • A few tweaks to the query DSL that reduce complexity and make it (slightly) less verbose
  • Query fields are now indexed from zero! (so it.field(0) instead of it.field(1))
  • Lots of improvements to API ergonomics & removal of tech debt
  • Lots of bug fixes since the last alpha release

This version does not work with the explorer because of a breaking change in the query DSL. To use the explorer with the alpha, use this URL: https://www.flecs.dev/explorer/v4?remote=true.

The release should be stable enough for experimentation.

Flecs script example

// New: a cleaner syntax allows for more natural type descriptions
struct Position {
  x = f32
  y = f32
}

assembly CheckBox {
  prop checked = bool: false

  // New: conditional logic!
  if $checked {
    Image("checked.png") // New: improved anonymous entity notation
  } else {
    Image("unchecked.png")
  }
}

// New: new syntax that improves ergonomics of working with assemblies
CheckBox my_checkbox(checked: true) {
  Position: {x: 400, y: 300} // New: a more consistent way to specify components

  // Streamlined syntax for creating child entities
  Label my_lbl("Hello world") {
    Position: {x: 100, y: 0}
  }
}

Query DSL example

// Old
Item, Player($this:self|up(ContainedBy))
// New
Item, Player($this|self|up ContainedBy)

What is missing?

  • A big usability update to prefabs is still underway
  • There are a handful of known bugs that still need to be fixed
  • Performance testing hasn't finished yet
  • Documentation has not been updated yet

When will v4 come out?

The updated goal is to release around the end of May, with a beta release coming out in around two weeks.

Where can I share feedback?

Post v4 feedback in this discussion post: https://github.com/SanderMertens/flecs/discussions/1181 or on the Flecs discord server, whichever you prefer!

⚠️ Do not use this release in an actual project! ⚠️

flecs - Flecs v4.0.1-alpha

Published by SanderMertens 7 months ago

What is this?

This is an early preview of the upcoming v4 release! 🎉

You can use this release to familiarize and play around with the new APIs and features before v4 comes out. The biggest difference between v3 and v4 is a new query engine that unifies filters, queries and rules in a single API.

Overview

  • All tests are passing on all platforms and compilers
  • The query API is mostly stable
  • Examples have been updated to the new APIs
  • Many parts of the API have been simplified
  • The release mostly works with the explorer and query editor

Code examples

// A system with query variables
world.system<Position>("SpaceshipsDockedToPlanet")
  .with<SpaceShip>()
  .with<DockedTo>("$obj")
  .with<Planet>().src("$obj")
  .each([](flecs::entity spaceship, Position& p) {
    // ...
  });
// By default queries are uncached. This is similar to a v3 filter/rule
world.query_builder<Position>()
  .with(flecs::ChildOf, "$parent")
  .each([](Position& p) {
    // ...
  });
// Adding .cached() enables caching, which is similar to a v3 query.
// Only the terms that are cacheable will be cached. This allows 
// for queries that are partially cached, which is not possible in v3.
auto q = world.query_builder<Position>()
  .with(flecs::ChildOf, "$parent")
  .cached()
  .build();
  
q.each([](Position& p) {
  // ...
});
// Queries can be named. This associates the query with an entity
// with the same name. Queries that are associated with an entity
// are cached. This means that by default all system queries enable 
// caching, just like in v3.
auto q = world.query_builder<Position>("Children")
  .with(flecs::ChildOf, "$parent")
  .build();

q.each([](Position& p) {
  // ...
});

// Queries that are associated with an entity need to be explicitly
// destructed. This is the same behavior as `flecs::entity`.
// Queries that are not associated with an entity are cleaned up
// when they go out of scope. This is the same behavior as
// `flecs::world` (RAII).
q.destruct();
flecs::world world_a;
{
  // World objects can now be copied. This just creates a handle to
  // the existing world, it doesn't create/copy a new world.
  flecs::world world_b = world_a;
}
void Move(ecs_iter_t *it) {
  Position *p = ecs_field(it, Position, 0); // Field indices now start from 0!
  Velocity *v = ecs_field(it, Velocity, 1);
  
  for (int i = 0; i < it->count; i ++) {
    p[i].x += v[i].x;
    p[i].y += v[i].y;
  }
}

The release should be stable enough for experimentation.

What is missing?

  • The APIs are not yet finalized. Big changes are still underway, especially in the C API
  • A few new features are still in development
  • There are a handful of known bugs that still need to be fixed
  • Performance testing hasn't finished yet
  • Documentation has not been updated yet

When will v4 come out?

There is still a lot that needs to happen before the release. The goal is to release around the end of April, with a higher probability of it being later than earlier.

Where can I share feedback?

Post v4 feedback in this discussion post: https://github.com/SanderMertens/flecs/discussions/1181 or on the Flecs discord server, whichever you prefer!

⚠️ Do not use this release in an actual project! ⚠️

flecs - Flecs v3.2.11

Published by SanderMertens 9 months ago

Highlights

  • Hytale is using Flecs as the backbone for their upcoming engine!
  • More than half of the contributions in this release are from the community ❤️
  • Work on Flecs 4.0 is well underway, with simpler query APIs and better performance! Follow progress here

Release notes

This version includes the following bugfixes:

  • Fix issue with parsing newlines in query strings
  • Fix issue with registration of nested types in module
  • Fix issue in rule engine with lookup variables and equality operators
  • Fix issue with rules that are partially trivial
  • Fix issue where a member with a missing MetaType wasn't correctly handled (thanks @ZeroErrors!)
  • Fix issue where query term with equality operator was incorrectly marked as trivial
  • Fix potential out of bounds read in rule engine
  • Fix JSON serialization error for labels with double quotes
  • Fix issue with evaluating R(_, _) and _(_, T) queries
  • Fix issues with not/optional operators and terms with any (_) source
  • Fix issue where rule compiler would not detect uninitialized lh of equality operator
  • Fix issue where ecs_ref_t could point to invalid component after table recycling
  • Fix issue in code that dedups events for multi-component observers
  • Fix issue where observer could access deleted id record during world cleanup

This version includes the following improvements:

  • [cpp] Add missing overloads for delete_with and remove_all (thanks @Charlie-83!)
  • [cpp] Add FLECS_CPP_NO_AUTO_REGISTRATION flag to disable automatic component registration
  • [cpp] Add flecs::string::contains
  • [cpp] Add support for associating a timer/tick source with a type (thanks @ZeroErrors!)
  • [cpp] Add missing const to entity_view methods (thanks @waywardmonkeys!)
  • [cpp] Add missing flecs::doc::get/set_color() functions (thanks @waywardmonkeys!)
  • [cpp] Mark explicit move ctors/operator= as noexcept (thanks @waywardmonkeys!)
  • [cpp] Remove redundant void arg of log function (thanks @waywardmonkeys!)
  • [query-dsl] Add support for R(A, B || C) syntax to DSL
  • [query] Fill out ecs_iter_t.system when using filters, queries and rules (thanks @BeanCheeseBurrito!)
  • [query] Improve string conversion of queries with equality operators
  • [rule] Skip empty ids for R(_, *) and *(_, T) queries
  • [json] Implement serializer for user-friendly JSON format
  • [json] Add option for serializing query field metadata
  • [rest] Fix issue where cached REST request would always return code 200
  • [rest] Add try parameter that prevents throwing HTTP error when trying out queries
  • [snapshot] Reduce copies when duplicating tables with non-POD components for snapshots (thanks @ZeroErrors!)
  • [strbuf] Simplify implementation of ecs_strbuf_t, improve performance
  • [http] Improve performance of ecs_http_server_request
  • [http] Enable caching of HTTP requests made from C API
  • [log] Don't mix writing to stderr/stdout in logging output
  • [log] Make output file used by logging functions configurable
  • [doc] Fix copy-paste issues with type names (thanks @waywardmonkeys!)
  • [doc] Fix relationship example by specifying inout (thanks @garrett-is-a-swann!)
  • [doc] Update Doxygen to v1.10.0 (thanks @ZeroErrors!)
  • [doc] Enable graphviz dot files in Doxygen (thanks @ZeroErrors!)
  • [doc] Change defgroup documents to use autobrief (thanks @ZeroErrors!)
  • [doc] Fix typos (thanks @waywardmonkeys!)
  • [doc] Fix typos and spelling errors (thanks @ZeroErrors!)
  • [doc] Fixed documentation link in quickstart addons section (thanks @DJLink!)
  • [doc] Remove spurious asterisk (thanks @waywardmonkeys!)
  • [doc] Use @code/@encode (thanks @waywardmonkeys!)
  • [doc] Fix grouping errors in C docs (thanks @waywardmonkeys!)
  • [doc] Link function names in doc comments (thanks @waywardmonkeys!)
  • [doc] Fix ecs_doc_get_name code samples (thanks @waywardmonkeys!)
  • [doc] Add tab widget for code snippets (thanks @ZeroErrors!)
  • [doc] Add Extermination Shock to readme
  • [doc] Add Hytale to readme
  • [doc] Improve doc addon docs (thanks @waywardmonkeys!)
  • [doc] Fix doxygen warnings (thanks @waywardmonkeys!)
  • [doc] Add missing doc.brief descriptions to flecs entities
  • [doc] Add C# example snippets to Quickstart, RestApi, System manuals (thanks @BeanCheeseBurrito!)
  • [ci] Update pages workflow actions (thanks @waywardmonkeys!)
  • [ci] Add macOS-14 Apple Silicon jobs (thanks @waywardmonkeys!)

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/4681e8606aa9204b97f6316d3611e9f0d2572852

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.10...v3.2.11

flecs - Flecs v3.2.10

Published by SanderMertens 10 months ago

Highlights

  • Significant performance improvements of the rule query engine:
    • Up to 4x faster when compared with v3.2.9 for simple component queries
    • Up to 6x faster when compared with filters for simple component queries
    • Many other improvements, like automatic reordering of terms & simplified control flow
  • Rules now support up traversal!

⚠️ The next release will merge the filter, rule and query implementations into a single query API, expect breaking changes! ⚠️

Release notes

This version includes the following bugfixes:

  • Fix memory leak with batched set commands for new components
  • Fix issue in detection of whether a query has no data fields
  • Fix missing argument in error trace in meta addon
  • Fix issue that would occur when units module is not imported before monitor module
  • Fix issue with invalidating observer reachable cache
  • Fix issue where on_set hook was invoked without deferred mode & could be called twice
  • Fix issue where structural changes from on_set hook could get lost
  • Fix issue where anonymous rule variables would be stored before regular variables in variable array
  • Fix issue where content type wasn't set on reply for cached HTTP request
  • Fix segfault when enqueueing custom event
  • Fix duplicate matches in rules with or (||) expressions
  • Fix issue where ids of terms without source weren't correctly set in rule iterator
  • Fix duplicate matches in rules with Any wildcards
  • Fix issue with any terms with not (!) operators in rules
  • Fix crash in query DSL parser when using Rel(X, Y, Z) syntax
  • Fix assignment within conditional expression error
  • Fix issue where cloning an entity with a name would throw an error

This version includes the following improvements:

  • [rules] Implement up traversal for rules
  • [rules] Simplify control flow instructions of rule engine
  • [rules] Add new rule instructions for trivial queries which batches evaluation of multiple terms
  • [rules] Implement automatic filtering of prefab/disabled entities
  • [rules] Implement rule instruction reordering to limit evaluation of instructions with only unknown variables
  • [rules] Improve performance of evaluating queries with exclusive wildcard pairs
  • [rules] Improve performance of setting data fields for trivial and mixed source queries
  • [meta] Add new id primitive type for component ids/pairs
  • [meta] Use %f in log statements for doubles instead of %d
  • [json] Remove overzealous check on whether it.ptrs is NULL in iterator serializer
  • [stats] Remove redundant REST statistics
  • [stats] Remove less than useful table statistics
  • [stats] Remove less than useful id statistics
  • [rest] Reduce log spam from invalid queries from REST API in release mode
  • [meson] Make compiling hello world example optional (thanks @apache-hb!)
  • [docs] Fix broken link in REST manual
  • [docs] Fix C++ module example in manual
  • [docs] Fix typos in source & documentation (thanks @waywardmonkeys!)
  • [docs] Doc improvements and formatting (thanks @waywardmonkeys!)
  • [docs] Remove redundant comment terminators (thanks @waywardmonkeys!)
  • [ci] Update GitHub actions to actions/checkount@v4 (thanks @waywardmonkeys!)
  • [ci] Fix new gcc warnings

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/ab33138f58c7a24cf05f662ac790d7cfbcfbe8e0

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.9...v3.2.10

flecs - Flecs v3.2.9

Published by SanderMertens 11 months ago

Highlights

  • Query DSL extension that makes it easier to traverse multiple edges of the same relationship:
    • ChildOf($pilot, $cockpit), ChildOf($cockpit, $plane) can now be rewritten as ChildOf($pilot, $cockpit, $plane)
  • New rule feature that makes it possible to lookup entities by name relative to a query variable:
    • Example: Turret($this), Health($this.cannon)
  • A new API for emitting and observing simple events on entities (c, cpp)
    • Example: window.emit<Resized>({800, 600})
  • A new API for enqueueing events into the command queue for deferred handling (c, cpp)
    • Example: window.enqueue<Resized>({800, 600})
  • Performance improvements:
    • Faster command batching in apps with lots of entities/commands enqueued from observers (~25x faster with 50k entities)
    • Query iteration improvements due to removal of complexity in table storage (~7%-17%)
    • Hierarchy creation/destruction improvements (~4%-7%)

Release notes

This version includes the following bugfixes:

  • Fix assert when journaling remove_all/delete_with functions
  • Fix world cleanup issue when using app_run
  • Fix assert when using a rule that assigns to an entity variable
  • Fix issue where batched commands could invoke multi-component OnSet observer with uninitialized values
  • Fix issue with creating C++ systems/observers with names relative to root
  • Fix issue with instantiating a prefab hierarchy with a recycled prefab id
  • Fix issue with deserializing large int64_t values (TODO: correctly handle large uint64_t values)
  • Fix macro redefined warning when defining both FLECS_DEBUG and FLECS_SANITIZE
  • Fix issue with evaluating filters with static sources that are no longer alive
  • Fix issue in cursor API with deserializing into top-level array types
  • Add missing flecs::Override to C++ API (thanks @BeanCheeseBurrito!)
  • Fix issue with parsing comments in value scopes in flecs script
  • Fix issue with setting pair components that have a recycled relationship id

This version includes the following improvements:

  • [cpp] Default to InOutNone when using .with() in query builder API
  • [cpp] Enable optional pairs in the C++ query builder (thanks @Thinkofname!)
  • [cpp] Add array method to flecs::component for registering components as array type
  • [cpp] Add default constructor to flecs::ref
  • [cpp] Add flecs::ref::try_ref method
  • [query-dsl] Add feature that expands R(A, B, C) into R(A, B), R(B, C)
  • [queries] Add ability to use cascade in descending order
  • [rules] Add support for by name lookups relative to query variables ($var.child_name)
  • [rules] Don't throw error when comparing variable to * or _ wildcards
  • [observers] Add support for entity events
  • [observers] Add support for enqueueing custom events into command queue
  • [json] Serialize large integers as strings in JSON serializer
  • [log] Improve assert performance (thanks @jbarthelmes!)
  • [log] Enable colors for logging in emcc builds
  • [metrics] Add ability to track member metrics on pair components
  • [docs] Fix broken link to meta_c in quickstart
  • [docs] Fix typo in quickstart
  • [docs] Fix crash in C++ hooks example
  • [docs] Fix issue with instancing code example in query manual
  • [docs] Add STACK_SIZE parameter to list of emcc parameters in quickstart
  • [docs] Add game_mechanics/factory example
  • [docs] Add more content to FAQ
  • [internals] Remove record_ptrs member from table
  • [internals] Rename flecs::_::invoker* to flecs::_::delegate*
  • [internals] Rename command constants from EcsOp* to EcsCmd*
  • [internals] Reduce complexity of command batching code
  • [ci] Fix warnings when compiling with -std=gnu2x
  • [ci] Fix missing field initializer warning on g++

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/466a28be07c4ecbc94fa8cccb9dc4a5ba4dabf96

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.8...v3.2.9

flecs - Flecs v3.2.8

Published by SanderMertens about 1 year ago

Highlights

  • A new iterable::find method that makes it easier to find entities using filters, rules and queries:
flecs::query<Position> q = ecs.query<Position>();

flecs::entity result = q.find([](Position& p) {
    return p.x == 20;
});

Release notes

This version includes the following bugfixes:

  • Fix crash in ecs_pipeline_init when passing invalid parameter
  • Fix incorrect INVALID_PARAMETER assert in ecs_entity_init when providing empty separator
  • Fix incorrect return type of flecs::iter::id
  • Fix potential double free in C++ when using each_term
  • Fix issue with parsing bitmask expressions with spaces
  • Fix issue with deleting & recycling the same id in command buffer
  • Fix flecs script crash when trying to assign an entity that's not a component in with statement
  • Fix flecs script issue with assignment after scope statement
  • Fix custom build issue when specifying FLECS_MONITOR and FLECS_REST
  • Fix world cleanup issue where regular entities could get cleaned up after components
  • Fix issue where observers/hooks were not executed in deferred mode if deferring was suspended
  • Fix issue where event could be propagated along incorrect relationship edge
  • Fix incorrect return type of world::id (thanks @Indra-db!)
  • Fix C++ issue that prevented using a release build of flecs with debug build app & vice versa
  • Fix issue where passing nullptr as name to world::use didn't work correctly (thanks @Indra-db!)
  • Remove incorrect template parameter from world::from_json
  • Fix issue where passing NULL as doc string would not remove doc component
  • Fix crash in ecs_iter_str
  • Fix issue on VS2019 where enum constant registration did not work correctly

This version includes the following improvements:

  • [cpp] Add table::get method for enum types (thanks @Indra-db!)
  • [cpp] Add iterable::find method
  • [cpp] Add parameter to world::lookup/entity::lookup to disable/enable recursive searching
  • [cpp] Remove unnecessary return in entity::modified (thanks @Indra-db!)
  • [cpp] Remove redundant component registration from entity::ref methods (thanks @Indra-db!)
  • [cpp] Add entity_builder::set_json
  • [cpp] Add back world::delta_time method
  • [meta] Allow for creating reflection data in deferred, suspended deferred and readonly modes
  • [script] Add ability to self-reference assembly instance through $this variable
  • [metrics] Add ability to create metrics for nested members
  • [alerts] Add summary counts to AlertsActive component
  • [cmake] Add support for building & running tests with cmake (thanks @Naios!)
  • [cmake] Increase cmake version (thanks @Sororfortuna!)
  • [doc] Fix typos in examples/documentation (thanks @Rageking8!)
  • [doc] Documentation corrections (thanks @999pingGG!)
  • [doc] Improve comments of fwd_declare_component example
  • [doc] Add missing argument to pair function in relationship manual example
  • [doc] Show how to call target() in relationship basics example
  • [doc] Fix incorrect documentation comments in C++ API

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/f0c12a99219706c120fd49fe9862749f32f740b5

Known issues:
https://github.com/SanderMertens/flecs/issues/1042
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.7...v3.2.8

flecs - Flecs v3.2.7

Published by SanderMertens about 1 year ago

Highlights

  • A new Flecs.NET C# binding by @BeanCheeseBurrito with a similar design as the C++ API!
  • Deferred set operations are now almost twice as fast in the C++ API 💨
  • New functions in the experimental JavaScript API for client-side replication of entities:
// Connect to flecs application
flecs.connect("http://localhost:27750")

// World that stores the joined result of two queries
let w = flecs.world()
  .query("SpaceShip, (Dockedto, *)")
  .query("Planet, Habitable")
  .on_update(() => {
    // Access replicated entities
    for (let s in w.entities["fleet"]) {
      const planet = w.entities[s.pairs.DockedTo];
      
      // Is spaceship docked to a planet?
      if (planet.tags.include("Planet") {
        // Is planet habitable?
        const habitable = planet.tags.include("Habitable") ? "habitable" : "inhabitable";
        console.log("SpaceShip " + s.name +  " is docked to a " + habitable + " planet!");
      }
    }
  });

  • The explorer can now show sync point statistics and which queries/systems an entity matches with:

Release notes

This version includes the following bugfixes:

  • Fix issue where ecs_table_get_column_size was interpreting column as type index
  • Fix regression with using get with wildcard id
  • Replace invalid cast in Windows OS API with TEXT()
  • Fix crash in JSON serializer when trying to serialize variables for query iterators
  • Fix issue with JSON type serializer and nested structs
  • Fix issue where operations in yield_existing observers weren't always deferred
  • Fix issue where overriding exclusive relationships could cause an entity to have multiple instances
  • Fix module registration issue across DLLs that could cause an INVALID_COMPONENT_SIZE assert

This version includes the following improvements:

  • [c] Fix inconsistency in naming of get_ctx/set_ctx functions
  • [c] Add binding_ctx and ctx_free/binding_ctx_free to world
  • [c] Add ctx/binding_ctx to query objects
  • [c] Add Private trait to more internal components
  • [c++] Assert when attempting to create a nested pair id
  • [c++] Improve performance of deferred C++ set operations
  • [c++] Fix issue in filter builder API with pair singletons
  • [timer] Allow for timer randomization to reduce spikes in pipeline schedule
  • [queries] Add support for setting $this variable on query iterators
  • [meta] Shorten enum constant names by removing name prefix/enum type name prefix
  • [json] Add ecs_entity_to_json_desc_t::serialize_ids option
  • [json] Add ecs_iter_to_json_desc_t::serialize_term_labels option
  • [json] Add ecs_iter_to_json_desc_t::serialize_id_labels option
  • [json] Remove serialize_meta_ids option
  • [json] Add option to serializer to return all queries an entity matches with
  • [json] Support serialize_id_labels and serialize_variable_labels in combination with serialize_table
  • [json] Allow for toggling private components in combination with serialize_table
  • [stats] Add statistics for sync points
  • [doc] Fix typo in OS API header
  • [doc] Fix example in query manual (thanks @jbarthelmes!)
  • [doc] Fix outdated documentation in query manual and manual
  • [doc] Fix typo in query manual (thanks @pfeodrippe!)
  • [doc] Fix documentation for ecs_new_w_pair in manual
  • [doc] Fix links in flecs script tutorial
  • [doc] Fix & improve documentation in main header (thanks @copygirl!)
  • [doc] Add new C# binding by @BeanCheeseBurrito to README
  • [doc] Add questions to FAQ on how to debug issues with the explorer
  • [doc] Remove redundant group_by callback from group_iter example
  • [ci] Suppress new clang warning

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/563b5476cf13afdeff70fe120ad9d4308da9350b

Breaking changes

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.6...v.3.2.7

flecs - Flecs v3.2.6

Published by SanderMertens about 1 year ago

Highlights

  • Realtime strategy game Tempest Rising uses Flecs!
  • 20% performance increase for add/remove operations when entity already has the component
  • Experimental new web tool and JavaScript API for working with the Flecs REST API
  • Improved support and CI testing for MinGW targets

Release notes

This version includes the following bugfixes:

  • Fix issue with queries and recycled component ids
  • Fix JSON serializer issue where serialize_alerts is enabled but module is not imported
  • Fix meta bug where member count was ignored if explicit offset was provided (thanks @ZeroErrors!)
  • Fix C++ compiler errors when using ecs_map_t macro API
  • Fix assert when serializing entity alerts for alert without message template
  • Fix recursive cleanup issue for entities with multiple relationships to parent entity
  • Fix C++ component hook registration issue when child type was registered before parent

This version includes the following improvements:

  • [c] Fix inconsistencies between column index and type index in table API
  • [c] Fix naming inconsistencies in table API
  • [cpp] Fix inconsistencies between column index and type index in flecs::table API
  • [cpp] Fix naming inconsistencies in flecs::table API
  • [cpp] Add component::member overload that takes pointer to member (thanks @ZeroErrors!)
  • [cpp] Add const to flecs::string::size and flecs::string::length (thanks @yuyoyuppe!)
  • [cpp] Add world::scope(const char*) method (thanks @sasichkamega!)
  • [meta] Add support for packed structs (thanks @ZeroErrors!)
  • [meta] Remove unused size/alignment from EcsMetaType (thanks @ZeroErrors!)
  • [rest] Reduce amount of default enabled parameters for REST query endpoint
  • [internals] Simplify table data structures
  • [internals] Improve organization and naming of source files
  • [doc] Add note to FAQ about why (recycled) entity ids can be large
  • [doc] Add Tempest Rising to README
  • [doc] Add note on empty entities to cleanup order
  • [ci] Add msys/mingw builds to CI
  • [ci] Fix orphaned tests

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/e66a97d07528be158c1875b7193612904d203ef7

Breaking changes

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.5...v3.2.6

flecs - Flecs v3.2.5

Published by SanderMertens about 1 year ago

Highlights

  • Manually ran pipelines can now run multithreaded systems!
  • Lots of bugfixes and small improvements :)
  • The entity inspector in the explorer can now show incoming relationship edges:

Release notes

This version includes the following bugfixes:

  • Fix leaking field in AlertInstance component
  • Fix leak in query cache with entity filter (union relationships/bitset components/flattened trees)
  • Fix issue where ecs_count didn't include prefabs and disabled entities
  • Fix issue with using OVERRIDE flag in plecs scripts
  • Fix issue with reporting alert severity in JSON serializer
  • Fix issue with importing flecs.monitor without flecs.meta
  • Fix compilation issues in FreeBSD (thanks @SirLynix!)
  • Fix issue where removed argument was not correctly passed by ecs_commit
  • Fix issue where ecs_commit wouldn't enter deferred mode while executing the operation
  • Fix issue where ecs_iter_t::other_table would get reset for observers after event propagation
  • Fix issue with calling .get() on flecs::table/flecs::range from stage
  • Fix issue where REST API would return malformed JSON on seralization error (thanks @ZeroErrors!)
  • Fix issue where C++ component with the same name as a core entity would be incorrectly registered
  • Fix incorrect ifdef that checked for MSVC instead of POSIX (thanks @MilanDierick!)
  • Fix issue with change detection for queries with static sources
  • Fix issue with change detection and writing to shared terms
  • Fix issue in rule engine where variable writes in OR chains weren't treated as conditional
  • Fix issue where getting the target of a union relationship could return not alive entity handle
  • Fix issue with systems that configure both interval and rate
  • Fix memory corruption issues when using nested iterators (thanks @johnse-hypixel!)
  • Fix incorrect assert when computed alignment mismatched actual alignment
  • Fix issue where world passed to C++ rule iterator wasn't used

This version includes the following improvements:

  • [core] Remove ability to get entity id array as field with index 0 (thanks @ZeroErrors!)
  • [c] Add ecs_singleton_set_ptr (thanks @darkuranium!)
  • [cpp] Add entity_builder::scope method that returns world object scoped to entity
  • [cpp] Add flecs::iter::entities method (thanks @ZeroErrors!)
  • [cpp] Add world::run_pipeline<T> overload (thanks @ZeroErrors!)
  • [cpp] Add world::target method (thanks @ZeroErrors!)
  • [cpp] Add world::get_info, remove redundant functions (thanks @ZeroErrors!)
  • [pipeline] Add support for multithreading to ecs_run_pipeline (thanks @ZeroErrors!)
  • [meta] Add support for member value ranges
  • [json] Serialize alerts from children in entity serializer
  • [json] Add option to serialize incoming relationship edges for entity
  • [alerts] Add retain_period to alert configuration
  • [alerts] Make it possible for alerts to change severity based on a condition
  • [alerts] Add ability to generate alerts for member values that are out of range
  • [alerts] Reduce alert detection interval to 0.5 seconds
  • [monitor] Add WorldSummary component
  • [expr] Implement parent(), name() and doc_name() functions in expression parser
  • [http] Fix unused parameter warning (thanks @MilanDierick!)
  • [doc] Fix quickstart example
  • [doc] Fix filenames in documentation comments (thanks @ZeroErrors!)
  • [doc] Reduce usage of auto in C++ examples
  • [doc] Remove redundant functions from C++ examples
  • [doc] Update C++ examples that used older/more verbose API methods
  • [ci] Use stricter warning settings to compile code warning free
  • [ci] Switch asan build to run on Linux, which includes leakage reporting
  • [ci] Build code on additional compiler versions
  • [cmake] Add FLECS_STRICT flag that enables Werror and stricter warning settings

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/8539a8634bc6cc99a61efd5919ffe8f02c6b3478

Breaking changes

Known issues:
https://github.com/SanderMertens/flecs/issues/965
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.4...v3.2.5

flecs - Flecs v3.2.4

Published by SanderMertens over 1 year ago

Highlights

  • Performance improvements!
    • 25%-80% performance improvement when creating/deleting entity hierarchies
    • 70%-90% performance improvement when reparenting/changing entity names
    • 40% performance improvement for event forwarding
    • 5%-20% performance improvement when iterating cached queries
  • A new query feature that allows for nesting terms
  • A new alerting addon that monitors graph queries for invalid patterns, with explorer UI:

Release notes

This version includes the following bugfixes:

  • Fix issue with calling children() on builtin Wildcard/This entities
  • Fix issue in rule engine with anonymous source variables and component terms

This version includes the following improvements:

  • [alerts] Implement alert addon
  • [cpp] Add world::children method for iterating root entities
  • [expr] Add ecs_interpolate_string function
  • [expr] Add support for evaluation of dotexpressions on variables (e.g. $foo.x)
  • [rules] Add support for nested query terms
  • [queries] Reduce overhead of query cache entry by not inlining infrequently used fields
  • [queries] Reduce complexity and indirection of query cache data structures
  • [systems] Allow rate/interval to be modified with ecs_system_init
  • [pipelines] Add support for integration with external tasks systems (thanks @gsnook!)
  • [docs] Correct parameter naming of flecs_hashmap_init (thanks @kagetu!)
  • [docs] Add section on task systems to system manual
  • [core] Allow Exclusive property to be removed from (unused) ids
  • [ux] Improve error messages in flecs_bulk_new, ecs_rule_iter
  • [internals] Improve naming of functions, constants and add more comments
  • [internals] Don't emit unnecessary TableFill/TableEmpty events
  • [internals] Don't emit unnecessary TableCreate/TableDelete events
  • [internals] Revalidate observer cache in more scenarios (reduces cache invalidation events)
  • [internals] Remove redundant calls to defer_begin/defer_end in bootstrap
  • [internals] Improve performance of id record creation for pairs
  • [internals] Don't inline infrequently used fields in ecs_table_t
  • [internals] Remove dead sorting code (thanks @jbarthelmes!)

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/f1a776066fc6d857c9aa1e7c3d7ff59069583750

Known issues:
https://github.com/SanderMertens/flecs/issues/969
https://github.com/SanderMertens/flecs/issues/965
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.3...v3.2.4

flecs - Flecs v3.2.3

Published by SanderMertens over 1 year ago

Release notes

This version includes the following bugfixes:

  • Fix crash when using change detection with queries that don't have $this terms
  • Fix issue with serializing large floating point values
  • Fix issue with creating user space observer for table events
  • Fix error message when using ECS_PRIVATE in ECS_STRUCT
  • Add missing emscripten include to app addon source

This version includes the following improvements:

  • [c] Change ecs_owns_id from macro to function
  • [queries] Reset query match counters after iteration has finished (improves change detection usability in systems)
  • [metrics] Add support for metrics that count the number of entities with an id
  • [http] Enable blocking for HTTP send call to improve stability of sending large replies
  • [docs] Fix broken links in documentation (thanks @MewSoul!)
  • [meson] Link with ws2_32 for Windows builds (thanks @randy408!)

Known issues:
https://github.com/SanderMertens/flecs/issues/969
https://github.com/SanderMertens/flecs/issues/965
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.2...v3.2.3

flecs - Flecs v3.2.2

Published by SanderMertens over 1 year ago

Highlights

  • New entity index data structure which improves performance of create/delete/add/remove by 10-20%
  • Replaced hash implementation with wyhash, improving table creation performance by 15-30%
  • Graph visualization of queries in the explorer!

Release notes

This version includes the following bugfixes:

  • Fix issue where assert would trigger during (component) id deletion
  • Fix issue with detecting redeclared variables in flecs script
  • Fix incorrect value of EcsTypeKindLast
  • Fix issue with creating query on entity that already has an existing query
  • Fix potential crash in ecs_iter_fini when using chained iterators
  • Fix issue where observer could cause emplace to return invalid pointer
  • Fix issue where With pair would assume type of pair target
  • Fix inconsistencies in enum constant registration between C and C++ APIs
  • Fix issues with symmetric relationships and recycled ids
  • Add missing ecs_rule_var_count, ecs_rule_var_name and ecs_rule_var_is_entity functions (thanks @copygirl!)
  • Fix inconsistent naming of desc size constants
  • Fix issue where id record could get deleted twice during world cleanup
  • Fix incorrect JSON serialization of pair ids
  • Fix bug in query creation with recycled relationship id
  • Add missing imports to monitor module
  • Fix assert when iterating rule with 0 source
  • Fix possible leak when reassigning system/observer ctx/binding_ctx
  • Fix crash in ecs_pipeline_stats_get when obtaining stats for pipeline with one task system

This version includes the following improvements:

  • [cpp] Don't compile ECS_FUNC_* marco's for C code (thanks @aganm!)
  • [cpp] Add component::constant overload that works with enum classes
  • [cpp] Remove entity_view::delta_time function
  • [cpp] Change argument of enable_rest to HTTP port
  • [c] Remove unnecessary sep variable initialization in ecs_new_from_path_w_sep (thanks @copygirl!)
  • [c] Add port member to ecs_app_desc_t
  • [http] use non-blocking socket for recv which increases stability for servers with many clients
  • [docs] Add note on pipeline switching performance
  • [docs] Update outdated cascade example in quickstart
  • [docs] Fix incorrect comment for iterable::each (thanks @ZeroErrors!)
  • [docs] Fix error in quickstart example
  • [json] Improve error handling of JSON iterator serializer
  • [rest] Propagate serialization errors to REST endpoints
  • [rest] Log errors that happen while replying to REST request to console
  • [metrics] Improved logic for deriving metric name from enum constant in untyped_component::metric
  • [internals] Implement new entity index data structure
  • [internals] Replace hash function with wyhash
  • [portability] Emulate POSIX atomics for systems that do not have GNU builtins (thanks @aganm!)
  • [portability] Add compiler support for tinycc (thanks @aganm!)
  • [ci] Add vs2017 job to CI

Benchmark results
https://github.com/SanderMertens/ecs_benchmark/tree/7bb9d7cf672f0b5991b5faff4f5f8cc5afcd94ef

Breaking changes:

Known issues:
https://github.com/SanderMertens/flecs/issues/969
https://github.com/SanderMertens/flecs/issues/965
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.1...v3.2.2

flecs - Flecs v3.2.1

Published by SanderMertens over 1 year ago

Highlights

  • Query iteration improved 20-40% when iterating components
  • New addon for recording component values and relationships as metrics
  • New FLECS_LOW_FOOTPRINT compiler flag that reduces memory usage

Release notes

This version includes the following bugfixes:

  • Fix issue where change detection would not clear when using ecs_query_next_table
  • Fix crash where wildcard id record was deleted before matching non-wildcard id record
  • Fix issue where during world fini a filter incorrectly decreased the refcount of an id record
  • Fix issue with setting This variable to entity for filters
  • Fix issue where OnRemove observer wasn't invoked after deferred batched clear
  • Fix issue in flecs script where pair target was not looked up correctly
  • Fix issue where filter would compute incorrect size for (*, T) pair term

This version includes the following improvements:

  • [cpp] Add flecs::world::reset method deletes/recreates a world
  • [cpp] Add get/set methods to flecs::world for singleton pairs
  • [cpp] Add method to get filter from flecs::rule (thanks @Thinkofname!)
  • [cpp] Add flecs::rule::rule_str method
  • [cpp] Add flecs::entity_view::path_from method
  • [cpp] Allow iterable::set_var to be called for filters
  • [cpp] Add flecs::iter::column_index method
  • [cpp] Add flecs::table::column_size method
  • [c] Add ecs_field_column_index function
  • [c] Add ecs_table_get_column_size function
  • [queries] Improve performance of trivial query iteration (addresses performance regression in 3.2.0)
  • [queries]Implement change detection for flattened tables
  • [filters] Return data for OR terms if the type of terms in the OR chain is the same
  • [filters] Reuse same sizes array for all results of filter (improves cache locality during iteration)
  • [filters] Improve performance of filter creation
  • [metrics] Implement metrics addon
  • [docs] Add scene management example (thanks @benjitrosch!)
  • [docs] Fix typos/grammar issues in relationships doc (thanks @oznogon!)
  • [docs] Fix outdated docs for ecs_filter_iter
  • [docs] Fix outdated docs for ecs_bulk_new_w_id
  • [docs] Fix link to FAQ in readme
  • [cmake] Update version number to 3.2 (thanks @podsvirov!)
  • [internals] Reduce overhead of tables that don't use bitsets/union relationships/flattening
  • [internals] Add FLECS_LOW_FOOTPRINT compiler flag for reduced memory utilization

Breaking changes:

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314
https://github.com/SanderMertens/flecs/issues/951

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.2.0...v3.2.1

flecs - Flecs v3.2.0

Published by SanderMertens over 1 year ago

Release announcement

Flecs 3.2 is out!

Release notes

This version includes the following bugfixes:

  • Fix issue with batched set commands and emitting OnSet events
  • Fix issue where bitset iteration index could go out of bounds
  • Fix issue where ecs_get_target would try inheritance for relationship with DontInherit
  • Fix error in custom_phases_no_builtin C++ example
  • Fix issue in JSON serializer with large string values
  • Fix issue in JSON serializer with entity ids at offset
  • Fix potential crash in ecs_get_target_id_for
  • Correctly set ecs_iter_t::offset in component hooks
  • Fix issue with suspending deferred mode
  • Fix issue in cursor API with double assignment after dotmember
  • Fix issue in script parser with binary operator followed by component assignment
  • Fix issue with vectors in JSON serializer
  • Fix issue where comments inside value blocks didn't work correctly in Flecs script
  • Fix issue with setting name string that overlaps with existing name in deferred mode
  • Add missing implementation of ecs_rule_get_filter
  • Fix issue with command ordering when setting name after reparenting
  • Fix compilation issue with new version of emcc
  • Fix issue where event for multiple ids triggered for wrong entity
  • Fix issue where event for multiple ids triggered multiple times for same observer
  • Fix issue where id in table was not updated after calling ecs_set_entity_generation
  • Fix issue that prevents using ecs_get_target_for_id from stage
  • Fix issue with component registration across binaries in multithreaded applications
  • Fix memory leak in HTTP server
  • Fix issue with importing C module in multiple worlds
  • Fix component registration issue with binaries compiled by different compilers
  • Fix issue with component registration of world::vector
  • Correct for overshoot value when returning delta_system_time for interval systems

This version includes the following improvements:

  • [c] Add missing const qualifiers to query functions
  • [c] Add missing const qualifier to ecs_id_in_use
  • [c] Add ecs_get_parent convenience function
  • [cpp] Add flecs::rule::move method
  • [cpp] Don't assert when creating invalid rule, add flecs::rule::is_valid method
  • [cpp] Add flecs::entity_builder::set_alias method
  • [cpp] Add API for singleton pairs to flecs::world
  • [cpp] Ensure world is cleaned up when app().run() returns
  • [rules] Rule engine refactor
  • [rules] Improved support for Not, Optional, Or operators
  • [rules] Added support for fuzzy name matching
  • [rules] Added support for dependent terms
  • [rules] Added a query profiler for analyzing term performance
  • [rules] Many improvements to performance, VM, data structures, runtime
  • [rules] Add option to auto-match unresolved identifiers at query creation time by name
  • [rules] Add support for using any (_) variable as term source
  • [rules] Add support for queries that start with Not/Optional terms
  • [rules] Add support for transitive queries with any (_) target
  • [rules] Add support for transitive queries with self modifier for target
  • [rules] Allow for usage of relationships other than IsA for component inheritance
  • [rules] Add support for parsing variable values from argument string
  • [rules] Add performance optimization for trivial rule queries
  • [filters] Default to InOutNone if the term type is not known beforehand
  • [filters] Change interface for Or operator to allow for neighboring Or terms
  • [queries] Improve query sorting performance
  • [queries] Add assert on invalid order_by component id
  • [core] Implement relationship flattening
  • [core] Replace all remaining occurrences of ecs_vector_t with ecs_vec_t
  • [core] Cache (ChildOf, *) id record on world for improved performance
  • [core] Cache (Identifier, Name) id record on world for improved performance
  • [core] Add AlwaysOverride component property
  • [core] Ensure children of a prefab are also tagged as prefabs
  • [core] Add stricter check on adding properties to components that are already in use
  • [meta] Add conversion to cursor API from bool to int
  • [meta] Throw less confusing error in cursor API when assigning out of bounds element/member
  • [rest] Add validity checks on offset/limit parameters
  • [rest] Add functions to call REST API from C
  • [http] Implement request caching (replaces caching mechanism of REST API)
  • [doc] Fix conflicting declaration in quickstart example
  • [doc] Fix outdated code example in systems manual
  • [doc] Add build instructions to quickstart for cmake and bake
  • [doc] Fix incorrect link in README to prefab documentation
  • [doc] Add parent(), target_for() to query section of relationship manual
  • [doc] Expand explorer section of REST manual with query examples
  • [script] Add experimental support for loading managed scripts
  • [script] Add experimental support for assemblies
  • [script] Allow for setting nested members in expression
  • [script] Add support for deriving variable name from assigned member
  • [script] Add support for adding variables as components
  • [script] Make EXPR/META addon mandatory when using script addon
  • [script] Add support for using foo.* syntax
  • [script] Add support for module foo syntax
  • [script] Add Flecs script tutorial
  • [script] Add support for assigning singletons with $ :- Component{}
  • [log] Add ecs_log_get_level

Breaking Changes

Known issues

https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.1.5...v3.2.0

flecs - Flecs v3.1.5

Published by SanderMertens over 1 year ago

Highlights

  • A big upgrade to the reflection framework which can now serialize/deserialize custom (including STL) types!
  • New functions to serialize & deserialize a world to & from JSON
  • Improved performance of iterating queries with tag fields (+30-50%)
  • Improved performance of table creation in apps with lots of cached queries (+70-90%)
  • Improved performance of notifying multiple observers for the same event (+20-30%)

Release notes

This version includes the following bugfixes:

  • Fix issue where symmetric relationship would be cleaned up before its observer
  • Fix issue in debug mode where entity generation check could use wrong index in dense array
  • Fix issue where on_set hook was not called before observers during command batching
  • Changed incorrect return type of ecs_id_is_tag to bool
  • Ensure destructor is called on moved away from value in command queue
  • Fix memory leaks when using a global flecs::world object
  • Ensure destructor is called on moved away from column when merging tables
  • Fix lambda compilation issue when using Visual Studio 2017

This version includes the following improvements:

  • [core] Allow for ecs_ensure to be called from stage
  • [core] Add Traversable property to allow for relationships that are acyclic but not traversable
  • [core] Only apply DontInherit property to IsA traversal
  • [meta] Serialization & deserialization support for opaque types
  • [meta] Add methods for deserializing values & entities to C++ API
  • [json] Add option to JSON serializer to serialize all contents of a matched table
  • [json] Add functions for serializing/deserializing world to/from JSON
  • [observers] Improve performance of invoking multiple observers for the same event
  • [queries] Improve detection and handling of query terms without data
  • [cpp] Remove redundant world argument from flecs::entity constructor in id::second()
  • [cpp] Add begin/end methods to flecs::type so it can be iterated
  • [cpp] Add entity::view method for safe upcast from staged flecs::entity object
  • [cpp] Automatically disable enum reflection for compilers that don't support it
  • [docs] Improve documentation of get_mut
  • [docs] Rewrite of the FAQ
  • [docs] Add query example for singletons, add singleton section to quickstart
  • [ux] Add assert when not using stage when creating iterator in multi threaded world
  • [internals] Use observers for notifying queries of new tables
  • [internals] Improve performance of ecs_bulk_init by using faster function to update entity index
  • [internals] Implement small utility API for parsing JSON strings

Breaking Changes:

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.1.4...v3.1.5

flecs - Flecs v3.1.4

Published by SanderMertens over 1 year ago

Highlights

Performance improved in this release for 116 in a total of 120 benchmarks! Here are a few of the most significant improvements between v3.0.0 and v3.1.4 (which also includes improvements from command batching & the observer cache):

Benchmark v3.0.0 v3.1.4 Difference
has_id 8.92ns 4.38ns +50.90%
get_id 7.18ns 3.69ns +48.61%
get_mut_id 12.22ns 7.35ns +39.85%
set_id 29.13ns 11.85ns +59.32%
add_remove_1_tag 20.43ns 17.63ns +13.71%
add_remove_cmd_16_tags 40.40ns 17.55ns +56.56% (command batching)
get_mut_cmd_16 47.17ns 18.65ns +60.46% (command batching)
create_delete_tree_depth_10 19.27us 8.24us +57.25%
emit_propagate_depth_10 1.52us 194.33ns +87.25% (observer cache)
query_iter_16_tags_4_terms 56.39ns 26.15ns +53.63%

Release notes

This version includes the following bugfixes:

  • Ensure HAVE_EXECINFO is defined on all platforms
  • Fix compilation issue on clang 16 (thanks @gorilux!)
  • Add missing flecs_cpp.c to the meson build file
  • Fix issue where non-instanced query with multiple traversal terms did not match entities
  • Fix broken links in documentation
  • Remove <strong></strong> from documentation markdown headers
  • Fix issue where atomic id generation was used without threading
  • Fix issue where flecs::ref would store stage instead of world
  • Fix assert in observer cache after deleting parent with relationship to child
  • Fix issue with passing string to ecs_set_name that overlaps with current name
  • Fix compile error when passing existing object to set<R, T>
  • Fix memory corruption when using ecs_bulk_init with existing table
  • Fix command batching issue with adding ChildOf pair while removing name

This version includes the following improvements:

  • [core] Require entities to be alive for ECS operations
  • [core] Deferred ecs_get_mut_id now returns reference to actual component if it exists (thanks @dmlary!)
  • [c] Add matching *_DECLARE convenience macro's for each *_DEFINE macro
  • [cpp] Add world::get_ref
  • [docs] Lots of small improvements to documentation (thanks @copygirl!)
  • [docs] Move build instructions from README to Quickstart
  • [docs] Improve build instructions for gcc/clang on Windows
  • [ux] Add example for entity::emplace
  • [internals] Faster map implementation that no longer stores a variable size payload
  • [internals] Use array vs. sparse set to lookup id records with low ids
  • [internals] Replace usage of ecs_vector_t in sparse set with faster ecs_vec_t
  • [internals] Add new/faster sparse set operations that assume id is alive
  • [internals] Cleanup sparse set API
  • [internals] Replace code of ecs_has_id with faster implementation
  • [internals] Remove redundant code from table graph operations
  • [internals] Improve performance of defer/suspend mechanism
  • [internals] Improve performance of pipelines queries by adding self flag to System term

Breaking Changes:

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

New Contributors

Full Changelog: https://github.com/SanderMertens/flecs/compare/v3.1.3...v3.1.4

flecs - Flecs v3.1.3

Published by SanderMertens almost 2 years ago

Highlights

Release notes

This version includes the following bugfixes:

  • Fix issues with looking up numerical ids from scope (e.g. foo::bar::100)
  • Fix issue where reachable cache invalidation would not iterate all ids
  • Fix issue with parsing entity path that can't fit in 32bit int
  • Fix issue where filter with self term is created before id
  • Fix issue where id records were incorrectly deleted for ecs_remove_all/ecs_delete_with
  • Fix issue with adding ChildOf pair and deferred ecs_entity_init
  • Fix issues with updating EcTableHasObserved flag (fixes reachable cache asserts)
  • Fix issue where id record could not get cleaned up correctly (fixes reachable cache asserts)
  • Add move hook to Pipeline component (fixes segfault when using multiple pipelines)

This version includes the following improvements:

  • [entities] Use empty separator string to prevent tokenization of name in ecs_entity_init
  • [cpp] Add const to query class methods
  • [cpp] Add const to iterable class methods
  • [cpp] Add emplace_override for pairs
  • [queries] Prevent query rematching from happening more than once per query/frame
  • [pipelines] Prevent adding empty operation at end of schedule
  • [table] Support calling ecs_table_get from stage
  • [units] Add units for hyperlinks, images and files
  • [units] Add Length::Pixel unit
  • [docs] Add doxygen headers to source and include files
  • [docs] Add edcs_get_depth, entity_view::depth, ecs_table_get_depth, table::depth functions
  • [docs] Add doxygen documentation
  • [docs] Replace old flecs.dev site with doxygen generated one
  • [docs] Remove dead links to docsforge pages
  • [docs] Add instructions for how to fix compilation errors related to time/socket functions
  • [ux] Improved C/C++ APIs for working with tables
  • [ux] Remove redundant tracing when component is reregistered
  • [ux] Throw assert when trying to delete entity/component that is still queried for
  • [internals] Move code out of query iterator in preparation of union/bitset support for filters
  • [internals] Remove redundant relationship traversal call from table edge creation code

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

flecs - Flecs v3.1.2

Published by SanderMertens almost 2 years ago

Highlights

  • The Flecs explorer can now edit component values!
  • Systems can now be registered with an OnStart phase which is ran only in the first frame

Release notes

This version includes the following bugfixes:

  • Fix issue with C++ bitmask binding (type must now inherit from flecs::bitmask)
  • Fix issue where use_low_id was not set by ECS_COMPONENT
  • Fix issues with invoking ctor/move/dtor when merging tables
  • Fix issue where observer could be invoked for wrong table
  • Fix invalid read in multithreaded app after pipeline rebuild
  • Fix race condition between pipeline worker and no_readonly system
  • Fix issue where term with wildcard pair & self flag would not iterate all permutations
  • Fix issue where get_mut<First, Second> would always return First*

This version includes the following improvements:

  • [cpp] Add missing const to flecs::world methods
  • [cpp] Add missing const to flecs::entity_view methods
  • [cpp] Change argument type of run_pipeline to flecs::entity_t
  • [cpp] Add observer::query method
  • [pipeline] Refactor of pipeline code
  • [pipeline] Add OnStart phase for systems that are ran only at startup
  • [rest] Add set endpoint for remotely setting component values
  • [rest] Add delete endpoint for remotely deleting an entity
  • [internals] Add debugging instrumentation to allocator
  • [internals] Remove redundant code
  • [internals] Add missing tests for get pair operations
  • [internals] Split off entity filter code (union relationships/bitsets) from query iterator code

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

flecs - Flecs v3.1.1

Published by SanderMertens almost 2 years ago

Highlights

  • Observer refactor with new hierarchy cache that can improve event propagation performance up to 200x
  • Systems are now excluded from a schedule when their module or phase is disabled
  • Single threaded systems are now guaranteed to run on main thread
  • New journaling addon

Release notes

This version includes the following bugfixes:

  • Fixed issue with page/worker iterators and InOutNone
  • Fixed issue with invoking on_add hooks when using ecs_bulk_init
  • Fixed issue with searching for union relationships
  • Fixed C++ enum relationships on Apple Clang 14
  • Fixed issue with batched deferred emplace and remove
  • Fixed issue where ctx/binding_ctx was not set for multithreaded systems
  • Fixed race condition with no_readonly systems in multithreaded apps
  • Fixed issue where pipeline would resume at incorrect point in schedule after merge
  • Fixed issue with batched clear commands
  • Fixed issue where auto-overriding components would write to wrong component
  • Fixed issue with parsing template name in module
  • Fixed assert during deferred component registration in multithreaded app
  • Fixed leak in pipeline cleanup
  • Fixed issues with sending valid preflight response in HTTP server
  • Prevent sending response to invalid socket
  • Don't call send on socket when reply has no data
  • Fixed issue with setting symbol on entity with IsA relationship
  • Fixed issue with observer that has multiple fixed sources
  • Fixed escaping issue in doc strings in JSON serializer
  • Fixed issue where serialized path of core entity was not relative to root
  • Fixed HTTP socket leak, add timeout to connection socket
  • Replaced incorrect cast to float to ecs_ftime_t in system addon
  • Fixed issue with flecs::filter move assignment

This version includes the following improvements:

  • [c++] Add support for run callback to C++ observers
  • [c++] Add typed method for getting iterator ctx in C++ API
  • [c++] Add support for run callback to C++ systems
  • [c++] Add .term<R>(string) and .term(R, string) overloads to filter builder
  • [c++] Add shorthand with/without methods to filter builder API
  • [c++] Add pair support to emplace
  • [c++] Add pair support for flecs::ref
  • [c++] Ensure set, set_override use move for pairs where possible
  • [journal] Implement journaling addin
  • [queries] Improve performance of query rematching
  • [filters] Allow for creation of named filters/rules
  • [filters] Cache id record on filter terms for faster matching
  • [rules] Enable overriding transitive behavior with self flag
  • [observers] Refactor observer code for improved event propagation performance
  • [observers] Implement reachable id cache to improve event performance of adding relationships
  • [pipeline] Add doc name to pipeline schedule tracing
  • [pipeline] Exclude systems from pipeline with disabled phase/disabled module
  • [pipeline] Run single threaded systems on main thread
  • [iterator] Add ecs_iter_first function
  • [query DSL] Add query DSL support for specifying flags for (r, t) notation
  • [commands] Reduce lookups during command batching (performance improvement)
  • [storage] Reduce overhead of table graph edges, improve table creation speed
  • [stats] Always use double for metric types to avoid precision issues
  • [stats] Add REST and HTTP statistics
  • [units] Add frequency units
  • [rest] Add endpoint for requesting results of existing query
  • [rest] Add endpoint for enabling/disabling entities
  • [rest] Add caching for named query requests
  • [rest] Start/stop HTTP servers when enabling/disabling REST module
  • [http] Send HTTP headers in send thread
  • [http] Improve response times and handling of HTTP preflight requests
  • [http] Always use double precision for time values in HTTP server
  • [doc] Add system examples
  • [doc] Update C++ examples with simplified query variable syntax
  • [doc] Add example to show how to forward declare component/tag variables
  • [doc] Fix typos in manuals
  • [doc] Add custom phase example that does not use builtin phases
  • [doc] Remove outdated reference to ecs_scope_iter
  • [doc] Replace flecs::entity with flecs::entity_t in C++ order_by example
  • [doc] Improve pipeline section of manual
  • [doc] Add observer examples for C/C++
  • [ux] Improve error message for conflicting symbols during implicit component registration
  • [build] Improve directory structure of cmake build to match visual studio
  • [build] Improve bazel build to support .inl files
  • [internals] Don't free chunks in flecs_sparse_clear (performance improvement)
  • [internals] Use faster sparse set function in table event batching admin
  • [internals] Replace map with faster sparse set in generic allocator
  • [internals] Use faster storage for id records in low id range
  • [internals] Inline type_info sparse set

Known issues:
https://github.com/SanderMertens/flecs/issues/844
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314

flecs - Flecs v3.1.0

Published by SanderMertens about 2 years ago

Release announcement

Flecs 3.1 is out!

Release notes

This version includes the following bugfixes:

  • Fixed issue with terms that had Not operator in combination with relationship traversal
  • Fixed issues in C++ API where component hooks could get reregistered across DLLs
  • Fixed issue in queries with shared components and change detection
  • Fixed issue in queries with fixed source terms and change detection
  • Fixed issue in sparse set with bulk id generation and recycling
  • Fixed issues with using emplace and commands
  • Fixed issue in group_by example so it always returns alive entity identifier
  • Fixed issue in pipeline with no_staging system after inactive system
  • Fixed issue with instanced queries and nested iter calls
  • Fixed issue where using observer with multiple components would crash when setting ctx and ctx_free
  • Fixed issue where ecs_ref_t would do more lookups than necessary
  • Fixed C++ issue with overriding a prefab child that was associated with a type
  • Fixed missing call to move hook when moving entity in table
  • Fixed double free for moved-away from component
  • Fixed leak where world was not destroyed when using app::run
  • Fixed table lock assert when adding component in observer during merge
  • Fixed crash when OnRemove observer adds component to deleted entity
  • Fixed issue with using ecs_add_path when path is root
  • Fixed issue with assigning the same name to an entity after reparenting
  • Fixed JSON crash on union pair with invalid target
  • Fixed crash where no_staging system activated at end of schedule
  • Fixed leak when multithreaded pipeline rebuilt after running the last system
  • Fixed issue where HTTP server would write to memory of purged connection
  • Fixed issue where observer would not restore iterator state for next observer
  • Fixed issues with redefining addon macro's
  • Fixed issues with parsing identifiers that start with _ in ECS_STRUCT
  • Fixed issues with parsing pointer types in ECS_STRUCT

This version includes the following improvements:

  • [c] Added ecs_children / ecs_children_next functions for iterating an entity's children
  • [c++] Added entity_view::parent function (shorthand for target(flecs::ChildOf)
  • [c++] Made calling world::module in module constructor optional
  • [c++] Added each/iter overloads that accept a stage
  • [c++] Allow module entity to be retrieved using world::entity / world::component
  • [threading] Allowed using the world (vs. stage) in single threaded system running in multi threaded apps
  • [commands] Command batching, which reduces archetype moves for entities when doing deferred operations
  • [entity DSL] Improved syntax
  • [entity DSL] Added entity DSL examples
  • [entity DSL] Added support for multiline strings
  • [entity DSL] Added support for anonymous entities
  • [entity DSL] Added variable support (reusable values)
  • [entity DSL] Added support for using simple arithmetic expressions
  • [entity DSL] Implemented a vscode extension for DSL syntax highlighting
  • [os api] Added function to get OS API struct (for easier support in language bindings)
  • [queries] Added ability to add user-defined context to query groups
  • [queries] Added assert on invalid usage of Filter in combination with queries
  • [queries] Added ecs_query_next_table for fast iteration where only tables are needed
  • [queries] Improved performance/cleanup technical debt of query change detection
  • [queries] Added ecs_query_get_group_info function
  • [observers] Added EcsFilter/flecs::Filter term flag for terms only for filtering, not receiving events
  • [observers] Added level 3 trace that shows which observers are invoked
  • [pipeline] Improved detection of sync points, correctly handle wildcard queries
  • [pipeline] Always insert sync point after no_staging system to ensure schedule consistency
  • [stats] Added FLECS_ACCURATE_COUNTERS for tracking allocation counters in multithreaded apps
  • [stats] Added new statistics for allocators, events and performance tracking
  • [stats] Organized statistics into categories
  • [stats] Improved system time measurement so it no longer includes merge time
  • [stats] Fixed issue where measuring system time for last part of schedule could be skipped
  • [stats] Use 64bit counters to reduce occurrences of stat overflows
  • [stats] Ensure counter metrics are monotonically increasing in case of overflow
  • [rest] Added brief descriptions to stats endpoints for improved visualization in explorer
  • [http] Don't enqueue requests for connections that are no longer alive
  • [http] Don't keep HTTP connection open longer than timeout
  • [http] Set timeout on connection receive socket
  • [http] Set SO_KEEPALIVE on connection socket so server is notified when client drops connection
  • [http] Implement send queue to prevent blocking on main thread when sending reply
  • [http] Fixed issue with sending replies without payload
  • [ux] Throw assert when component id overlaps with reserved bits for id flags
  • [ux] Added typename to invalid ctor/dtor error messages
  • [ux] Added assert when attempting to use ecs_bulk_init on stage
  • [internals] Reduced number of heap allocations with internals now mostly using custom allocators
  • [internals] Allow for overriding of ECS_HI_COMPONENT_ID macro
  • [internals] Allow for overriding of ECS_ID_CACHE_SIZE macro
  • [internals] Reduced bits reserved for id flags from 8 to 4
  • [internals] Improved detection of platforms where execinfo/backtrace is not available
  • [internals] Improved strbuf API so it relies less on strlen
  • [internals] Improved performance of flecs_sparse_clear

Known issues:
https://github.com/SanderMertens/flecs/issues/765
https://github.com/SanderMertens/flecs/issues/714
https://github.com/SanderMertens/flecs/issues/620
https://github.com/SanderMertens/flecs/issues/478
https://github.com/SanderMertens/flecs/issues/314