mzaks / entitascookbook Goto Github PK

Post it here so it's always available as a reference

• Welcome
• Components
  -- Flag Component
  -- Unique Component
  -- Component with Action properties
• Entity
  -- Dictionary vs Array backed
  -- Entity reference counting
  -- Entity lifecycle
  -- Entity as a Component property
• Context
  -- Defining different Context Types
• Group
• Matchers
• Observers
• System
  -- Init System
  -- Continuous System
  -- Reactive System
  -- Cleanup System
  -- Teardown System
• Index
  -- Simple keys
  -- Complex Keys
  -- PrimaryEntityIndex
• Code generation
  -- Roslyn
  -- Entitas-Lang
• Entitas + Unity3D
  -- Event-Listeners for GUI
  -- Adding Unity GameObjects at runtime with Parent-Children references
  -- Object Pooling
  -- Activate, Deactivate GameObject
• Input Entities
• Serialisation
• Blueprints
• Event Logging
• State Loading / Reloading
• Multiplayer design
• Test Driven Development

Entitas is a very good implementation of ECS, and it's being used in more and more of our projects. But there's too little official guide for us to learn it throughly, and your book is concise and comprehensive which just fit our needs. So please continue your work, we're looking forward of it, thx! ;)

Moreover, I'm glad to translate your book into Chinese for you to benefit more game developers, let's make ECS more open, what do you say? XD

/Library/Frameworks/Mono.framework/Versions/Current/bin/mono /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/Jenny.exe client gen -v /Volumes/BOOTCAMP/UnityProjects/devel/Preferences.properties
Loading assemblies from /Volumes/BOOTCAMP/UnityProjects/devel/Jenny
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Analytics.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Analytics.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.CLI.Utils.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.CLI.Utils.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.CodeGeneration.CodeGenerator.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.CodeGeneration.CodeGenerator.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.CodeGeneration.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.CodeGeneration.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Logging.Formatters.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Logging.Formatters.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Logging.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Logging.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Networking.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Networking.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Serialization.CLI.Utils.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Serialization.CLI.Utils.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Serialization.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Serialization.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Utils.dll
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/DesperateDevs.Utils.dll
Jenny.exe load: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/Jenny.exe
➜ Loading: /Volumes/BOOTCAMP/UnityProjects/devel/Jenny/Jenny.exe
Client is connecting to 127.0.0.1:3333...
Client connected to 127.0.0.1:3333
Sending 67 bytes via 127.0.0.1:3333
Client received 8001 bytes from 127.0.0.1:3333
gen -v /Volumes/BOOTCAMP/UnityProjects/devel/Preferences.properties
gen -v /Volumes/BOOTCAMP/UnityProjects/devel/Preferences.properties
System.IndexOutOfRangeException: Index was outside the bounds of the array.
at DesperateDevs.Utils.StringExtension.LowercaseFirst (System.String str) [0x00000] in <9072220868e3419fb2254be31d01f033>:0
at Entitas.CodeGeneration.Plugins.CodeGeneratorExtentions.Replace (System.String template, System.String contextName) [0x0000c] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.CodeGeneratorExtentions.Replace (System.String template, Entitas.CodeGeneration.Plugins.ComponentData data, System.String contextName) [0x00007] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.generateInterface (Entitas.CodeGeneration.Plugins.ComponentData data) [0x0006a] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.generate (Entitas.CodeGeneration.Plugins.ComponentData data) [0x00014] in <484d9c1880e14b63b06a0d601c028277>:0
at System.Linq.Enumerable+SelectManySingleSelectorIterator2[TSource,TResult].ToArray () [0x00028] in <f7cad77794fc4fa5bf9a33531f4b94b4>:0 at System.Linq.Enumerable.ToArray[TSource] (System.Collections.Generic.IEnumerable1[T] source) [0x0001f] in :0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.Generate (DesperateDevs.CodeGeneration.CodeGeneratorData[] data) [0x0005f] in <484d9c1880e14b63b06a0d601c028277>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CodeGenerator.generate (System.String messagePrefix, DesperateDevs.CodeGeneration.IPreProcessor[] preProcessors, DesperateDevs.CodeGeneration.IDataProvider[] dataProviders, DesperateDevs.CodeGeneration.ICodeGenerator[] codeGenerators, DesperateDevs.CodeGeneration.IPostProcessor[] postProcessors) [0x0019b] in <343d5ab23e5c473d85369814468878e4>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CodeGenerator.Generate () [0x00000] in <343d5ab23e5c473d85369814468878e4>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CLI.GenerateCommand.run () [0x0001d] in :0
at DesperateDevs.CLI.Utils.AbstractCommand.Run (System.String[] args) [0x00018] in <7227560b90be4d8f98b442c971580104>:0
at DesperateDevs.Serialization.CLI.Utils.AbstractPreferencesCommand.Run (System.String[] args) [0x000bb] in <409cebcb85194cb1ac0fef8f89a91a88>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CLI.ServerCommand.onReceived (DesperateDevs.Networking.AbstractTcpSocket socket, System.Net.Sockets.Socket client, System.Byte[] bytes) [0x00059] in :0
System.IndexOutOfRangeException: Index was outside the bounds of the array.
at DesperateDevs.Utils.StringExtension.LowercaseFirst (System.String str) [0x00000] in <9072220868e3419fb2254be31d01f033>:0
at Entitas.CodeGeneration.Plugins.CodeGeneratorExtentions.Replace (System.String template, System.String contextName) [0x0000c] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.CodeGeneratorExtentions.Replace (System.String template, Entitas.CodeGeneration.Plugins.ComponentData data, System.String contextName) [0x00007] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.generateInterface (Entitas.CodeGeneration.Plugins.ComponentData data) [0x0006a] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.generate (Entitas.CodeGeneration.Plugins.ComponentData data) [0x00014] in <484d9c1880e14b63b06a0d601c028277>:0
at System.Linq.Enumerable+SelectManySingleSelectorIterator2[TSource,TResult].ToArray () [0x00028] in <f7cad77794fc4fa5bf9a33531f4b94b4>:0 at System.Linq.Enumerable.ToArray[TSource] (System.Collections.Generic.IEnumerable1[T] source) [0x0001f] in :0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.Generate (DesperateDevs.CodeGeneration.CodeGeneratorData[] data) [0x0005f] in <484d9c1880e14b63b06a0d601c028277>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CodeGenerator.generate (System.String messagePrefix, DesperateDevs.CodeGeneration.IPreProcessor[] preProcessors, DesperateDevs.CodeGeneration.IDataProvider[] dataProviders, DesperateDevs.CodeGeneration.ICodeGenerator[] codeGenerators, DesperateDevs.CodeGeneration.IPostProcessor[] postProcessors) [0x0019b] in <343d5ab23e5c473d85369814468878e4>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CodeGenerator.Generate () [0x00000] in <343d5ab23e5c473d85369814468878e4>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CLI.GenerateCommand.run () [0x0001d] in :0
at DesperateDevs.CLI.Utils.AbstractCommand.Run (System.String[] args) [0x00018] in <7227560b90be4d8f98b442c971580104>:0
at DesperateDevs.Serialization.CLI.Utils.AbstractPreferencesCommand.Run (System.String[] args) [0x000bb] in <409cebcb85194cb1ac0fef8f89a91a88>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CLI.ServerCommand.onReceived (DesperateDevs.Networking.AbstractTcpSocket socket, System.Net.Sockets.Socket client, System.Byte[] bytes) [0x00059] in :0
System.IndexOutOfRangeException: Index was outside the bounds of the array.
at DesperateDevs.Utils.StringExtension.LowercaseFirst (System.String str) [0x00000] in <9072220868e3419fb2254be31d01f033>:0
at Entitas.CodeGeneration.Plugins.CodeGeneratorExtentions.Replace (System.String template, System.String contextName) [0x0000c] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.CodeGeneratorExtentions.Replace (System.String template, Entitas.CodeGeneration.Plugins.ComponentData data, System.String contextName) [0x00007] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.generateInterface (Entitas.CodeGeneration.Plugins.ComponentData data) [0x0006a] in <484d9c1880e14b63b06a0d601c028277>:0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.generate (Entitas.CodeGeneration.Plugins.ComponentData data) [0x00014] in <484d9c1880e14b63b06a0d601c028277>:0
at System.Linq.Enumerable+SelectManySingleSelectorIterator2[TSource,TResult].ToArray () [0x00028] in <f7cad77794fc4fa5bf9a33531f4b94b4>:0 at System.Linq.Enumerable.ToArray[TSource] (System.Collections.Generic.IEnumerable1[T] source) [0x0001f] in :0
at Entitas.CodeGeneration.Plugins.ComponentEntityApiInterfaceGenerator.Generate (DesperateDevs.CodeGeneration.CodeGeneratorData[] data) [0x0005f] in <484d9c1880e14b63b06a0d601c028277>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CodeGenerator.generate (System.String messagePrefix, DesperateDevs.CodeGeneration.IPreProcessor[] preProcessors, DesperateDevs.CodeGeneration.IDataProvider[] dataProviders, DesperateDevs.CodeGeneration.ICodeGenerator[] codeGenerators, DesperateDevs.CodeGeneration.IPostProcessor[] postProcessors) [0x0019b] in <343d5ab23e5c473d85369814468878e4>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CodeGenerator.Generate () [0x00000] in <343d5ab23e5c473d85369814468878e4>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CLI.GenerateCommand.run () [0x0001d] in :0
at DesperateDevs.CLI.Utils.AbstractCommand.Run (System.String[] args) [0x00018] in <7227560b90be4d8f98b442c971580104>:0
at DesperateDevs.Serialization.CLI.Utils.AbstractPreferencesCommand.Run (System.String[] args) [0x000bb] in <409cebcb85194cb1ac0fef8f89a91a88>:0
at DesperateDevs.CodeGeneration.CodeGenerator.CLI.ServerCommand.onReceived (DesperateDevs.Networking.AbstractTcpSocket socket, System.Net.Sockets.Socket client, System.Byte[] bytes) [0x00059] in :0 Index was outside the bounds of the array.
Client is disconnecting...
Client disconnected

I think it would be easier to contribute to this cookbook if it were hosted on the official wiki, instead of a standalone repo. Or, if you're hesitant, at least a wiki on this repo. What do you think?