Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add recipe and rewrite some sections for simplicity #153

Merged
merged 2 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 45 additions & 27 deletions src/app/start/unity/start-unity.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ <h2>Ecsact Integration Package</h2>
<a href="https://docs.unity3d.com/Manual/Packages.html" target="_blank"
>Unity Package</a
>
and is <strong>required</strong> to use Ecsact with Unity. Installing the
latest integration is easy.
and is <strong>required</strong> to use Ecsact with Unity.
</p>
<ol>
<li>Start your unity project</li>
Expand All @@ -31,7 +30,7 @@ <h2>Ecsact Integration Package</h2>
language="uri"
codeBlockVariationOption
optionTitle="Unity Package Git URL">
https://github.com/ecsact-dev/ecsact_unity.git</pre
https://github.com/ecsact-dev/ecsact_unity.git</pre
>
</code-block-variation>
</li>
Expand All @@ -46,6 +45,18 @@ <h2>Ecsact Integration Package</h2>
outputs for entries</a
>.
</section>
<section>
<h2>The Ecsact Window</h2>
<p>
If the Ecsact package was successfully installed, there will be a new
window under
<code
>Edit <span class="i24">arrow_right</span> ProjectSettings
<span class="i24">arrow_right</span> Ecsact</code
>. This is where Ecsact is configured and any setup below happens here.
</p>
<img src="assets/UnityEcsactPage.png" width="800" height="200" />
</section>
<section>
<h2>Assembly</h2>
<p>
Expand All @@ -59,46 +70,53 @@ <h2>Assembly</h2>

<p>
You can either do that yourself, or the integration will do that
automatically with the dependencies for you!
automatically with the dependencies for you.
</p>

<p>
Go to:
<code
>Edit <span class="i24">arrow_right</span> ProjectSettings
<span class="i24">arrow_right</span> Ecsact</code
>
under System Implementations.
Go to the <code>System Implementations</code> section of the Ecsact window
and press the <code>Create New Assembly Definition</code>button. Follow
the prompt to choose where it's created.
</p>
<img src="assets/assembly_setup.png" width="800" height="200" />
<p>
All you have to do is press the button and follow the prompt to choose
where it's created.
</p>
<p></p>
</section>
<section>
<h2>Unity Sync</h2>
<p>
Enabling
To enable
<a routerLink="/docs/unity/unity-sync" routerLinkActive="active"
>Unity Sync</a
>
is very simple. All you have to do is go to
<code
>Edit <span class="i24">arrow_right</span> ProjectSettings
<span class="i24">arrow_right</span> Ecsact</code
>
and checkmark <code>Enable Unity Sync</code>. When enabled, it will search
for any Unity Sync files automatically and add them to its pool which is
listed below.
go to the <code>Runtime Settings</code> section and checkmark
<code>Enable Unity Sync</code>. When enabled, it will search for any C#
files using Unity Sync automatically and display them under
<code>Unity Sync Scripts.</code>
</p>
<img src="assets/UnitySyncEnable.png" width="800" height="300" />

</section>
<section>
<h2>Recipes</h2>
<p>
Ecsact supports having multiple <a>recipes</a>. You can use other
implementations, or there's one available for EnTT that comes packaged in
the Ecsact SDK. If you're having any errors related to recipes make sure
it's set under <code>Ecsact Build Settings</code>
</p>
<img src="assets/UnityRecipeConfig.png" width="800" height="300" />
</section>
<section>
<h2>Learning about the Unity Integration</h2>
<p>
If you want to learn about the Ecsact Integration for Unity, you can
follow our <a href="start/tutorials/unity/basic-example">tutorial</a> that
goes over the basics.
To learn more about the Ecsact Integration for Unity, you can follow our
<a
routerLink="/start/tutorials/unity/basic-example"
routerLinkActive="active"
>tutorial</a
>
that goes over the basics. You can also refer to the
<a routerLink="/docs/overview" routerLinkActive="active">documentation</a>
under <code>Unity Integration</code> to learn more.
</p>
</section>
</article>
2 changes: 2 additions & 0 deletions src/app/start/unity/start-unity.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {CommonModule} from '@angular/common';
import {Component, OnInit, ChangeDetectionStrategy} from '@angular/core';
import {CodeBlockVariationComponent} from '../../../components/code-block-variation/code-block-variation.component';
import {CodeBlockVariationOptionDirective} from '../../../components/code-block-variation/code-block-variation-option.directive';
import {RouterModule} from '@angular/router';

@Component({
selector: 'ecsact-start-unity',
Expand All @@ -10,6 +11,7 @@ import {CodeBlockVariationOptionDirective} from '../../../components/code-block-
changeDetection: ChangeDetectionStrategy.OnPush,
imports: [
CommonModule,
RouterModule,
CodeBlockVariationComponent,
CodeBlockVariationOptionDirective,
],
Expand Down
Binary file added src/assets/UnityEcsactPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/UnityRecipeConfig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/UnitySyncEnable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.