Ark v0.4.1

Ark v0.4.1

Ark is an archetype-based Entity Component System (ECS) for Go.

Changelog

This is a pure documentation improvement release.

Documentation

• Adds an example on how to implement systems (#221, #223)
• Adds an example on how to use non-ECS data structures with entities (#222)
• Adds chapter on resources to the user guide (#226)
• Adds a section on limitations of entity relationships to the user guide (#227)
• Tweaks and fixes entity relationships documentation (#230)

Ark v0.4.0

Ark v0.4.0

Ark is an archetype-based Entity Component System (ECS) for Go.

Release highlights

• Adds QueryX.Count for fast query counting.
• Provides MapX for up to 12 components.
• Improves ergonomics of MapX.Get and Map.Get.
• Performance improvements for query creation and component operations.
• Several bug fixes and improved error messages.
• Ark is dual-licensed with choice for MIT and Apache 2.0.

Changelog

Breaking changes

• Removes redundant information from stats: stats.World.ComponentCount and stats.Archetype.Components (#192)
• Unsafe Filter and Query renamed to UnsafeFilter and UnsafeQuery (#206)
• Constructors for MapX and Map return pointers instead of structs, for consistency (#208)

Features

• Adds QueryX.Count (#175)
• World stats contain separate reserved/used memory fields (#177)
• Provides MapX for up to 12 components (#182)
• Adds MapX.Set and Map.Set (#183)
• Adds function ResourceTypeID (#184)
• MapX.Get etc. return nil for missing components instead of panic (#189)
• Adds FilterX.New, MapX.New and ExchangeX.New to avoid repetition of generics (#207 by Tener)

Documentation

• Adds user guide chapter on Ark's error handling philosophy (#170)
• Adds information on uninformative Map.Get errors to API docs (#171)
• Adds benchmarks for build tag tiny (#180)
• Adds user guide chapter on world statistics (#193)

Performance

• Optimizes table creation and world stats by re-use of item sizes from archetypes (#177)
• Optimizes table column lookup, speeding up component operations and unsafe queries (#178)
• Batch operations use the filter cache for cached filters (#191)
• Optimizes query creation with 30% speedup (#197)
• More reliable inlining of query methods (#198)
• Optimizes memory sizes of internal types (#199, #200)
• Optimizes handling of relations in filters (#203)
• Rework of component assignment for a bugfix, accidentally speeding up assigning operations (#205)
• Uses a dedicated column type for entities in tables/archetypes, with a small speedup for component operations (216)

Bugfixes

• Fails with a more informative error when creating entities with missing relation targets (#169)
• Fixes false-positive debug checks on registered queries and unsafe get (#179)
• Fixes a bookkeeping bug when recycling relationship tables (#204)
• Fixes garbage collected pointers when assigning components using non-...Fn methods (#205)
• Fixes error on removing relationship components (#212)
• Checks that entities actually have relationship components to set target for (#212)

Other

• Reduces the maximum number of world locks to 64 to fail earlier on unclosed queries (#185)
• Ark is dual-licensed under MIT and Apache 2.0 (#202)

Ark v0.3.0

Ark v0.3.0

Ark is an archetype-based Entity Component System (ECS) for Go.

Release highlights

• A new, comprehensive User guide.
• Complete set of all batch operations.
• Filter caching for full speed despite many archetypes.
• Improved ergonomics of entity relations and method chaining.
• World statistics for insights into internals.
• Optimized archetype lookup and query creation.

Changelog

Breaking changes

• Relation component marker renamed from ecs.Relation to ecs.RelationMarker (#120)
• Relation target syntax changed, ecs.Rel is now ecs.RelIdx (#120)
• World argument in unsafe/ID-based filter moved from method Query to filter constructor (#137)
• Removes Mask and MaskTotalBits (makes it private/internal) (#158, #160)

Features

• Adds MapX.AddBatch and MapX.AddBatchFn batch operations (#100)
• Adds MapX.RemoveBatch batch operation (#100)
• Adds World.RemoveEntities batch operation (#100)
• Adds ExchangeX.AddBatch and ExchangeX.AddBatchFn batch operations (#101)
• Adds ExchangeX.RemoveBatch batch operation (#100)
• Adds ExchangeX.ExchangeBatch and ExchangeX.ExchangeBatchFn batch operations (#101)
• Adds Map.SetRelationBatch and MapX.SetRelationsBatch (#102)
• Adds World.NewEntities (#136)
• Adds all batch operations for Map (164)
• Initial world capacity is optional, 2nd value for relation archetype initial capacity (#109)
• Filters have permanent and ad-hoc relation targets (#113)
• Filters can be registered to the cache to speed up query iteration (#114, #116, #122)
• Relation targets can be specified by either component type or component index (#120)
• ExchangeX.Removes can be called multiple times in chains (#124)
• FilterX.Relations can be called multiple times in chains (#129)
• Adds methods Entity.ID and Entity.Gen for debugging purposes (#134)
• Adds MapX.NewEntityFn, MapX.AddFn, Map.NewEntityFn and Map.AddFn (#145)
• Adds ExchangeX.AddFn and ExchangeX.ExchangeFn (#145)
• Adds World.Stats for extracting world statistics (#147)
• Adds Unsafe.IDs to get all component IDs of an entity (#149)
• Adds methods ID.Index and ResID.Index (#159)

Documentation

• Adds a section on tools to the README (#94, #95)
• Adds a benchmark for unsafe queries and world access (#98)
• Adds a comprehensive user guide (#106, #107, #121, #123, #125, #126, #127, #133, #135)
• Adds tables with benchmarks to the user guide (#141)

Performance

• Implements archetype graph for faster lookup on transitions (#104)
• Optimizes query creation with 50% speedup (#144)
• Optimizes component operations with average 20% speedup (#146)

Bugfixes

• Locks the world during batch entity creation callback (#97)
• Checks the validity of relations when creating tables (#131)
• Checks the validity of relations in filters and component mappers (#132)

Ark v0.2.0

Ark v0.2.0

Ark is an archetype-based Entity Component System (ECS) for Go.

Changelog

Features

• Adds MapX.NewBatch and MapX.NewBatchFn for fast batch-creation of entities (#65)
• Adds ExchangeX.Add and ExchangeX.Remove (#70)
• Adds Map.GetRelationUnchecked (#75)
• Adds build tag tiny for 64 bit masks (#77)
• Adds QueryX.GetRelation, MapX.GetRelation and MapX.GetRelationUnchecked (#79)
• Adds unsafe, ID-based API (#80, #81, #82)
• Adds several functions and methods required for ark-serde (#83, #85)
• Adds resource shortcut functions GetResource and AddResource (#86)
• Adds World.Reset (#89)

Ark v0.1.0

Ark v0.1.0

Initial release of Ark.

Basic ECS implementation, as well as entity relationships.