Skip to content

Commit 0fd8eac

Browse files
zaucyzaucy
committed
feat: added initial unreal setup guide
1 parent 7f2c1c9 commit 0fd8eac

13 files changed

+122
-45
lines changed

‎src/app/home/home.component.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,8 @@ <h2>Commit to Ecsact without committing to an engine.</h2>
178178
the flexibility to make the best decision for your product.
179179
</p>
180180
<p class="text-sm">
181-
<a routerLink="/start/unity">Unity integration</a> is
181+
<a routerLink="/start/unity">Unity</a> and <a routerLink="/start/unreal">Unreal</a> integration is
182182
<strong>available now</strong> with
183-
<a routerLink="/start/unreal">Unreal</a> and
184183
<a routerLink="/start/godot">Godot</a> support planned for the near
185184
future. <a routerLink="/start/custom">Custom</a> integration is also
186185
possible for in-house or other engines that are not officially planned

‎src/app/start/start-overview.component.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h1 id="install" class="text-5xl max-w-sm m-0">Install Ecsact</h1>
107107
</div>
108108
</div>
109109

110-
<div class="max-w-xl mx-auto px-6 my-8">
110+
<div class="max-w-2xl mx-auto px-6 my-8">
111111
<h2 id="integrations" class="text-3xl">Integrations</h2>
112112
<p>
113113
After you've installed the Ecsact SDK check out our integrations or start
@@ -119,33 +119,33 @@ <h2 id="integrations" class="text-3xl">Integrations</h2>
119119
routerLink="/start/unity">
120120
<div class="brand unity w-full h-full"></div>
121121
</a>
122+
<a
123+
class="aspect-square rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
124+
routerLink="/start/unreal">
125+
<div class="brand unreal-stacked w-full h-full"></div>
126+
</a>
122127
<a
123128
class="aspect-square rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
124129
routerLink="/start/cli">
125-
<div class="w-full h-full relative text-center">
126-
<div class="absolute translate-y-[-50%] top-[50%] left-0 right-0">
127-
<span class="i48 text-text text-[600%]">terminal</span>
128-
<div class="text-text relative text-lg font-mono top-[-20px]">
129-
Ecsact CLI
130-
</div>
131-
</div>
132-
</div>
130+
<div class="brand ecsact-cli w-full h-full"></div>
133131
</a>
134132
</div>
135133

136134
<h3 id="integrations-coming-soon" class="text-3xl">Coming Soon</h3>
137135
<div class="grid grid-flow-col-dense gap-8 my-8 opacity-50">
138-
<a
139-
class="aspect-square rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
140-
routerLink="/start/unreal">
141-
<div class="brand unreal-stacked w-full h-full"></div>
142-
</a>
143-
144136
<a
145137
class="aspect-square rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
146138
routerLink="/start/godot">
147139
<div class="brand godot w-full h-full"></div>
148140
</a>
141+
<a
142+
class="aspect-square rounded-lg border border-transparent py-4 px-8">
143+
<div class="brand w-full h-full"></div>
144+
</a>
145+
<a
146+
class="aspect-square rounded-lg border border-transparent py-4 px-8">
147+
<div class="brand w-full h-full"></div>
148+
</a>
149149
</div>
150150

151151
<p class="text-center my-8">

‎src/app/start/start.component.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,7 @@
4444
<a routerLink="/start/cli" routerLinkActive="active">Overview</a>
4545
</ecsact-sidenav-section>
4646
<ecsact-sidenav-section title="Unreal Engine">
47-
<a routerLink="/start/unreal" routerLinkActive="active"
48-
>Ecsact Unreal Overview</a
49-
>
47+
<a routerLink="/start/unreal" routerLinkActive="active">Setup</a>
5048
</ecsact-sidenav-section>
5149
<ecsact-sidenav-section title="Godot">
5250
<a routerLink="/start/godot" routerLinkActive="active"

‎src/app/start/unreal/BUILD.bazel‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,7 @@ ng_project(
1313
"//:node_modules/@angular/common",
1414
"//:node_modules/@angular/core",
1515
"//:node_modules/@angular/router",
16+
"//src/components/code-block-variation",
17+
"//src/components/prism",
1618
],
1719
)

‎src/app/start/unreal/start-unreal.component.html‎

Lines changed: 75 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,77 @@
11
<article>
2-
<div class="brand unreal my-8 mx-2 h-16"></div>
3-
<p class="max-w-lg m-auto">
4-
Unreal Engine integration is not available at this time. If you would like
5-
to be notified when it is generally available please subscribe to the
6-
<a
7-
href="https://github.com/ecsact-dev/ecsact_unreal/issues/1"
8-
target="_blank"
9-
>general availability GitHub issue</a
10-
>.
11-
</p>
2+
<h1>Setting Up Unreal</h1>
3+
<section>
4+
<h2 id="plugin-install">Plugin Installation</h2>
5+
<p>
6+
To get started using Ecsact with your Unreal project we highly recommend installing the <a href="https://github.com/ecsact-dev/ecsact_unreal">Ecsact Unreal plugin</a>. At the time of writing this the Ecsact plugin has not been published to <a href="http://fab.com/" target="_blank">Fab</a> (<a href="https://github.com/ecsact-dev/ecsact_unreal/issues/21">tracking issue on github</a>.) For now the release archive are available on the <a href="https://github.com/ecsact-dev/ecsact_unreal/releases">Ecsact Unreal plugin Github releases</a> page. Extract
7+
<code>EcsactUnreal-Win64.zip</code> to your Unreal engine marketplace plugins directory to install.
8+
</p>
9+
<pre
10+
codeBlockVariationOption
11+
optionTitle="Bash"><code prism language="bash">
12+
# Ecsact Unreal zip contents should be extracted here
13+
[UE-Install-Dir]/Engine/Plugins/Marketplace/Ecsact
14+
</code></pre>
15+
<p></p>
16+
<p>Once you have installed the Ecsact Unreal plugin go to <code>Edit <span class="i24">arrow_right</span> Plugins</code>. Find the Ecsact plugin and make sure it's enabled for your project. You may have to restart your editor after enabling the plugin.</p>
17+
<div class="flex flex-row gap-8 justify-center">
18+
<a href="/assets/unreal/unreal-setup-01.png">
19+
<img src="/assets/unreal/unreal-setup-01.png" />
20+
</a>
21+
<a href="/assets/unreal/unreal-setup-02.png">
22+
<img src="/assets/unreal/unreal-setup-02.png" />
23+
</a>
24+
</div>
25+
<div class="flex flex-col lg:flex-row items-center justify-center gap-8 my-8">
26+
<div>
27+
<h2 id="plugin-install">Ecsact Plugin Settings</h2>
28+
<p>After enabling the Ecsact plugin and restarting your editor you should have new project settings specifically for Ecsact. You can find the settings in <code>Project Settings <span class="i24">arrow_right</span> Plugins <span class="i24">arrow_right</span> Ecsact</code>.</p>
29+
<p>
30+
Here you are able to configure and enable/disable different features of the plugin. For your first setup we recommend enabling the build system and adding the <code>rt_entt</code> build recipe.
31+
</p>
32+
</div>
33+
<a href="/assets/unreal/unreal-setup-03.png">
34+
<img class="max-w-md" src="/assets/unreal/unreal-setup-03.png" />
35+
</a>
36+
</div>
37+
<div class="flex flex-col lg:flex-row items-center justify-center gap-8 my-8">
38+
<a href="/assets/unreal/unreal-setup-04.png">
39+
<img class="max-w-sm" src="/assets/unreal/unreal-setup-04.png" />
40+
</a>
41+
<div>
42+
<h2 id="plugin-install">Whats next?</h2>
43+
<p>From this point on when you have the editor open the Escact Runtime will be built automatically when changes to <code>.ecsact</code> in your <code>Source</code> directory change. If no Ecsact files are detected you should get a warning in your editor output log. If this is your first Ecsact project then we recommend reading the <a routerLink="/start/tutorials/first-ecsact-file">your first Ecsact file</a> tutorial. Otherwise, take a look at some of the Ecsact Unreal plugin specific features below for further reading.</p>
44+
</div>
45+
</div>
46+
</section>
47+
48+
<section class="max-w-lg mx-auto text-center my-8">
49+
<h2 id="ecsact-unreal-plugin-features">Ecsact Unreal Plugin Features</h2>
50+
<div class="grid grid-cols-1 sm:grid-cols-2 gap-8 my-8">
51+
<a
52+
class="aspect-video rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
53+
routerLink="/start/unreal/runtime">
54+
<div>Ecsact Unreal Codegen</div>
55+
<div>TODO</div>
56+
</a>
57+
<a
58+
class="aspect-video rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
59+
routerLink="/start/unreal/codegen">
60+
<div>Ecsact Unreal Codegen</div>
61+
<div>TODO</div>
62+
</a>
63+
<a
64+
class="aspect-video rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
65+
routerLink="/start/unreal/runner">
66+
<div>Ecsact Runner</div>
67+
<div>TODO</div>
68+
</a>
69+
<a
70+
class="aspect-video rounded-lg shadow-lg border border-transparent hover:border-secondary transition-colors bg-content-bg py-4 px-8"
71+
routerLink="/start/unreal/runner-subsystems">
72+
<div>Ecsact Runner Subsystems</div>
73+
<div>TODO</div>
74+
</a>
75+
</div>
76+
</section>
1277
</article>

‎src/app/start/unreal/start-unreal.component.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
import {Component, OnInit, ChangeDetectionStrategy} from '@angular/core';
2+
import {RouterLink} from '@angular/router';
3+
import {PrismComponent} from '../../../components/prism/prism.component';
24

35
@Component({
46
templateUrl: './start-unreal.component.html',
57
changeDetection: ChangeDetectionStrategy.OnPush,
68
standalone: true,
9+
imports: [RouterLink, PrismComponent],
710
})
811
export class StartUnrealComponent implements OnInit {
912
constructor() {}

‎src/assets/brand/ecsact-cli-black.png‎

31.8 KB
Loading

‎src/assets/brand/ecsact-cli-white.png‎

34 KB
Loading

‎src/assets/unreal/unreal-setup-01.png‎

533 KB
Loading

‎src/assets/unreal/unreal-setup-02.png‎

85.2 KB
Loading

0 commit comments

Comments
 (0)