Initial commit, work with @zaucy refining docs (#50)

Author: Kelwan

src/app/docs/ecs/ecs.component.html

@@ -1,47 +1,68 @@
 <article>
 	<h1 id="ecs">What is ECS?</h1>
 	<p>
-		ECS stands for Entity Component System. It's an architecture that uses data
-		assocation over traditional methods like inheritance. Up to this point it's
-		been most commonly used for designing video games (Although it can and has
-		been used elsewhere)
+		Entity Component System (ECS) is an architecture that uses data assocation
+		over traditional methods like inheritance. It's been most commonly used in
+		video game development. We'll give a brief overview in relation to Ecsact,
+		but you can read more about ECS on
+		<a
+			href="https://en.wikipedia.org/wiki/Entity_component_system"
+			target="_blank"
+			><span class="i24">open_in_new</span>Wikipedia</a
+		>.
 	</p>
 
 	<h2 id="entities">Entities</h2>
 	<p>
-		An entitiy is a unique identifer that can hold zero or more components.
-		Components can be added or removed from the entity dynamically
+		An entitiy is a unique identifer that can be associated with zero or more
+		unique components. Components can be added or removed from the entity
+		dynamically.
 	</p>
 
 	<h2 id="components">Components</h2>
 	<p>
-		A component is a datatype that can be attached to an entity. Components
-		don't hold any behaviours and provides ways to be iterated over in systems
+		A component holds data and associates with an entity. Components don't
+		define behaviour, they provide state for systems.
 	</p>
 
 	<pre><code ecsactLangSyntax>
 		// Creates a component in Ecsact called Health
 		component Health {{'{'}}
-			int32 value;
+			// Maintains the state of how much "health" an entity has
+			i32 value;
 		{{'}'}}
+
+		// A tag to associate an entity with being "dead"
+		component Dead;
 	</code></pre>
 
 	<h2 id="systems">Systems</h2>
 	<p>
-		A system iterates over entities with the request components. They can add,
-		remove, and manipulate the data on components. This changes the behaviour of
-		an entity and alters its state through associated components
+		A system is a defined function that matches with entities meeting its
+		capabilities. They can add, remove, and manipulate the data on components.
+		This changes the behaviour of an entity and alters state through its
+		associated components.
 	</p>
 	<pre><code ecsactLangSyntax>
-		// This system iterates over every entity that has a Health Component
-		system UpdateHealth {{'{'}}
-			required Health;
+		// This system is run for every "alive" entity that has a Health Component
+		system CheckDead {{'{'}}
+			readonly Health;
+			// If the value of health is 0, the entity will be considered dead
+			adds Dead;
 		{{'}'}}
 	</code></pre>
 
 	<h2>Benefits to using ECS</h2>
-	<p>
-		ECS has high reusability and prevents creating constrictive design. With the
-		right components, an entity can be anything
-	</p>
+	<ul>
+		<h3>Performance</h3>
+		<p>Add performance benefits here</p>
+		<div>
+			<h3>Composition over inheritance</h3>
+			<p>
+				-- Separate data and behaviour, allowing you to mix and match easily and
+				quickly.
+			</p>
+			<h3>Try to add more</h3>
+		</div>
+	</ul>
 </article>

src/app/docs/setup/setup.component.html

@@ -3,7 +3,7 @@
 		<h2>Setting up Ecsact</h2>
 		<p>
 			Learn about integrations, custom use, and various ways that Ecsact can be
-			implemented
+			implemented.
 		</p>
 
 		<h3 id="unity-integration">Unity Integration</h3>
@@ -42,19 +42,19 @@ <h4 id="unity-ecsact">Unity Integration: Creating the .ecsact File</h4>
 		main package example;
 
 		component Example {{'{'}}
-			int32 example_value;
+			i32 example_value;
 		{{'}'}}
 
 		system UseExample {{'{'}}
-			required Example;
+			readwrite Example;
 		{{'}'}}
 		</code></pre>
 
 		<p>
 			<span class="i48">info</span>
 			Check out the
 			<a routerLink="/docs/lang" routerLinkActive="active">Language</a> section
-			to learn more about Ecsact syntax
+			to learn more about Ecsact syntax.
 		</p>
 		<p>
 			<b>NOTE:</b> You may get errors about missing components that you will
@@ -73,7 +73,7 @@ <h4 id="unity-ecsact">Unity Integration: Creating the .ecsact File</h4>
 		</p>
 
 		<h4 id="ecsact-code-output">Ecsact code output</h4>
-		<p>When the code is generated in C# and any other language being used</p>
+		<p>When the code is generated in C# and any other language being used:</p>
 		<ul class="list-disc list-inside">
 			<li>Packages are namespaces</li>
 			<li>Components are structs</li>
@@ -98,14 +98,14 @@ <h4 id="using-unity-ecsact">Using the Unity Integration</h4>
 		<pre><code prism language="csharp" class="language-csharp">ecsactRuntimeInstance.core.CreateRegistry()</code></pre>
 		<p>
 			Or you can use the default registry in the settings with the default
-			runner. If you're interested, read the next section
+			runner. If you're interested, read the next section.
 		</p>
 		<p>IMAGE HERE</p>
 
 		<h4 id="default runner">Default Runner</h4>
 		<p>
 			If you want to avoid creating and destroying instances of registries, you
-			can set up the default runner in the Ecsact settings
+			can set up the default runner in the Ecsact settings.
 		</p>
 		<ol>
 			<li>
@@ -155,7 +155,7 @@ <h4>Without Using Systems</h4>
 		</p>
 		<p>
 			First, we'll create an entity using the runtime instance we declared
-			earlier. This returns a unique integer we can use to identify it
+			earlier. This returns a unique integer we can use to identify it.
 		</p>
 		<pre><code prism language="csharp">entityId = runtime.core.CreateEntity(runner.registryId);</code></pre>
 
@@ -178,7 +178,7 @@ <h4>Without Using Systems</h4>
 		<p>
 			Because we are using the FixedUpdate runner, we'll want to declare the
 			<code>FixedUpdate()</code> function in Unity.From there, we'll retrieve
-			the component from the entity we created
+			the component from the entity we created.
 		</p>
 
 		<pre><code  prism language="csharp" class="language-csharp">
@@ -192,7 +192,7 @@ <h4>Without Using Systems</h4>
 		<p>
 			Now that we have an instance of the component, we can modify its
 			underlying data. In this case we only have "example_value", we'll increase
-			its value by 1 per FixedUpdate
+			its value by 1 per FixedUpdate.
 		</p>
 
 		<pre><code  prism language="csharp" class="language-csharp">
@@ -202,7 +202,7 @@ <h4>Without Using Systems</h4>
 
 		<p>
 			With the value increasing by 1, we want a simple way to see the result of
-			our changes. Let's log it out in the console
+			our changes. Let's log it out in the console.
 		</p>
 
 		<pre><code  prism language="csharp" class="language-csharp">
@@ -212,7 +212,7 @@ <h4>Without Using Systems</h4>
 		<p>
 			So the value has increased by 1, but how do we make sure the values inside
 			of the component is changed the next time it's retrieved? We'll call a
-			function to update the component so the changes you make are permanent
+			function to update the component so the changes you make are permanent.
 		</p>
 		<pre><code  prism language="csharp" class="language-csharp">
 				// Update the component value on each FixedUpdate
@@ -238,7 +238,7 @@ <h4>Without Using Systems</h4>
 		<h5>Next steps</h5>
 		<p>
 			If you enjoyed using Ecsact, and see the potential it can offer then check
-			out how systems can be used. SOME LINK TO systems tutorial
+			out how systems can be used. SOME LINK TO systems tutorial.
 		</p>
 		<div>Next Steps Filler</div>
 		<div>Next Steps Filler</div>

src/app/docs/unity/defaults/defaults.component.html

@@ -51,6 +51,25 @@ <h3>ExecutionOptions</h3>
 	</section>
 	<section>
 		<h2 id="pool">Pool</h2>
-		<p>The pool requires Unity Sync to be enabled</p>
+		<p>
+			The pool is made for Unity Sync, and only available when it's enabled in
+			your <code>settings</code>.
+		</p>
+		<h3>Target Scene</h3>
+		<p>
+			You can ensure that an entity only spawns in a scene using
+			<code>Pool.targetScene</code>
+		</p>
+		<h3>Root Game Object</h3>
+		<p>
+			You can make your entity a child a singular GameObject using
+			<code>Pool.rootGameObject</code>
+		</p>
+		<h3>Set Preferred Entity Game Object</h3>
+		<p>
+			Instead of creating a new GameObject by default for each entity, you can
+			set your own preffered GameObject using
+			<code>Pool.SetPreferredEntityGameObject</code>
+		</p>
 	</section>
 </article>

src/app/docs/unity/entities/BUILD.bazel

@@ -18,6 +18,7 @@ ng_ts_project(
     deps = [
         "//src/components/code-block-variation",
         "//src/components/ecsact-lang-syntax",
+        "//src/components/prism",
         "@npm//@angular/common",
         "@npm//@angular/core",
         "@npm//@angular/router",

src/app/docs/unity/entities/entities.component.html

@@ -8,19 +8,25 @@ <h2>Using the Registry</h2>
 			ID of the entity created
 		</p>
 		<code-block-variation>
-			<pre codeBlockVariationOption><code prism language="csharp">
-int entityId = Ecsact.Defaults.Registry.CreateEntity();
-			</code></pre>
+			<pre
+				codeBlockVariationOption><code prism language="csharp">int entityId = Ecsact.Defaults.Registry.CreateEntity();</code></pre>
 		</code-block-variation>
 	</section>
 	<section>
-		<h2>Dynamic Entity</h2>
+		<h2 id="dynamic_entity">Dynamic Entity</h2>
 		<p>
 			A convenient Monobehaviour that allows you to create an entity and add
 			components to it through the Unity UI
 		</p>
 		<img src="assets/DynamicEntityExample.png" width="300" height="300" />
 	</section>
+	<p>
+		Note: The dynamic entity uses
+		<a routerLink="/docs/unity/defaults" fragment="pool"
+			>SetPreferredEntityGameObject</a
+		>
+		when Unity Sync is enabled.
+	</p>
 	<section>
 		<h2>Generating Entities</h2>
 		<p>
@@ -29,8 +35,8 @@ <h2>Generating Entities</h2>
 		</p>
 		<code-block-variation>
 			<pre codeBlockVariationOption><code ecsactLangSyntax>
-				component Component A{{'{'}}{{'}'}};
-				component Component B{{'{'}}{{'}'}};
+				component ComponentA;
+				component ComponentB;
 
 				system GenerateEntity {{'{'}}
 					generates {{'{'}}

src/app/docs/unity/entities/entities.module.ts

@@ -4,10 +4,16 @@ import {RouterModule} from '@angular/router';
 import {EntitiesComponent} from './entities.component';
 import {CodeBlockVariationModule} from '../../../../components/code-block-variation/code-block-variation.module';
 import {EcsactLangSyntaxModule} from '../../../../components/ecsact-lang-syntax/ecsact-lang-syntax.module';
+import {PrismModule} from '../../../../components/prism/prism.module';
 
 @NgModule({
 	declarations: [EntitiesComponent],
-	imports: [RouterModule, CodeBlockVariationModule, EcsactLangSyntaxModule],
+	imports: [
+		RouterModule,
+		CodeBlockVariationModule,
+		EcsactLangSyntaxModule,
+		PrismModule,
+	],
 	exports: [EntitiesComponent],
 	bootstrap: [],
 })

src/app/docs/unity/system-impl/BUILD.bazel

@@ -17,6 +17,7 @@ ng_ts_project(
     ],
     deps = [
         "//src/components/code-block-variation",
+        "//src/components/prism",
         "@npm//@angular/common",
         "@npm//@angular/core",
         "@npm//@angular/router",

src/app/docs/unity/system-impl/system-impl.component.html

@@ -7,19 +7,15 @@ <h1>Implementing Systems in Unity</h1>
 	<section>
 		<h2>System Declaration</h2>
 		<p>
-			Systems have a <code>Unity Attribute</code> in its implementation. The
-			type name of the system is put here to get the correct
-			<code>context</code>. The context holds the logic of the system. This
-			includes getting components, generating entities and retrieving data on
-			actions.
+			Systems have a <code>C# Attribute</code> in its implementation. The type
+			name of the system is put here to get the correct <code>context</code>.
+			The context holds the logic of the system. This includes getting
+			components, generating entities and retrieving data on actions.
 		</p>
 		<code-block-variation>
 			<pre codeBlockVariationOption><code prism language="csharp">
 [Ecsact.DefaultSystemImpl(typeof(example.ExampleSystem))]
-public static void AddToExampleSystem
-	( EcsactRuntime.SystemExecutionContext context
-	)
-{{'{'}}
+public static void AddToExampleSystem(EcsactRuntime.SystemExecutionContext context) {{'{'}}
 	// Get component from the context
 	var value = context.Get<{{'example.Example'}}>();
 {{'}'}}

src/app/docs/unity/system-impl/system-impl.module.ts

@@ -1,12 +1,13 @@
 import {NgModule} from '@angular/core';
 import {RouterModule} from '@angular/router';
 import {CodeBlockVariationModule} from '../../../../components/code-block-variation/code-block-variation.module';
+import {PrismModule} from '../../../../components/prism/prism.module';
 
 import {SystemImplComponent} from './system-impl.component';
 
 @NgModule({
 	declarations: [SystemImplComponent],
-	imports: [RouterModule, CodeBlockVariationModule],
+	imports: [RouterModule, CodeBlockVariationModule, PrismModule],
 	exports: [SystemImplComponent],
 	bootstrap: [],
 })

src/components/ecsact-lang-syntax/ecsact-lang-syntax.module.ts

@@ -1,18 +1,10 @@
-import { NgModule } from '@angular/core';
-import { CommonModule } from '@angular/common';
-import { EcsactLangSyntaxComponent } from './ecsact-lang-syntax.component';
-
-
+import {NgModule} from '@angular/core';
+import {CommonModule} from '@angular/common';
+import {EcsactLangSyntaxComponent} from './ecsact-lang-syntax.component';
 
 @NgModule({
-  declarations: [
-    EcsactLangSyntaxComponent
-  ],
-  imports: [
-    CommonModule
-  ],
-  exports: [
-    EcsactLangSyntaxComponent
-  ]
+	declarations: [EcsactLangSyntaxComponent],
+	imports: [CommonModule],
+	exports: [EcsactLangSyntaxComponent],
 })
-export class EcsactLangSyntaxModule { }
+export class EcsactLangSyntaxModule {}