Commits

Michael Ludwig committed c143da3

Update README with release notes and description improvements.

  • Participants
  • Parent commits 223fdfd

Comments (0)

Files changed (1)

 Entreri
 =======
 
-Entreri is an entity-component framework useful for avoiding the OO-hell that 
-can develop when creating games in Java.
+Entreri is a data-oriented entity-component framework designed for high 
+performance applications and games. It scales well to tens of thousands of instances,
+in both memory and performance, and fits data models that require many similar
+objects of the same type, objects with composable types at runtime, and
+combinations thereof.
 
-It is specially designed for high performance, extensively avoids branching, 
-and features much better cache locality than using normal Java references. Using 
-well-specified conventions, components are mapped into packed memory structures,
-so that iteration is fast and cache friendly.
+Using annotations and minor limitations to type definitions, component data
+is packed into primitive arrays to improve cache locality. Fly-weight instances
+are then used to access the packed data.
 
 Java's garbage collection can move objects around, hurting locality when using 
 Object arrays or collections. By using primitive arrays or buffers storing
 
 In off-the-cuff performance tests, garbage collection in other entity-component 
 frameworks could cause performance to slow down by a factor of 2 to 4, while 
-Entreri remained consistently fast (pre-GC performances were effectively 
-identical).
+Entreri remained consistently fast (pre-GC performances near identical).
 
 Maven
 ~~~~~
- * version: 1.5.1
+ * version: 1.5.2
  * groupId: com.lhkbob.entreri
  * artifactId: entreri
+ 
+Release Notes
+~~~~~~~~~~~~~
+
+ 1.5.2
+ -----
+  * Improve PropertyFactory API to better support custom Property definitions 
+    that want to define new annotations to control default behavior, etc.
+  * Replace Controller data storage using Key objects with a simple Result API
+    that allows Controllers to express interest in data and have that injected
+    using custom interfaces defined by the computing controller.
+  
+ 1.5.1
+ -----
+  * Add protected onSet(int) method to ComponentData to better support 
+    ComponentData's that rely on unmanaged fields for caching.
+  * Add functionality to estimate memory usage by component type.
+  * Update ControllerManage to record run time performance of each controller,
+    for the last executed frame.
+  * Changed the no-argument process() method in ControllerManager to use the
+    real change in time from the last frame, instead of a fixed time delta.