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: remove references to deprecated runtime builder #136

Merged
merged 1 commit into from
Jul 5, 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
1 change: 0 additions & 1 deletion src/app/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ng_project(
"//src/app/docs/ecs",
"//src/app/docs/implementations",
"//src/app/docs/runtime",
"//src/app/docs/runtime-builder",
"//src/app/home",
"//src/app/install",
"//src/app/integrations/unity/install",
Expand Down
1 change: 0 additions & 1 deletion src/app/docs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ ng_project(
"//src/app/docs/lang",
"//src/app/docs/overview",
"//src/app/docs/runtime",
"//src/app/docs/runtime-builder",
"//src/app/docs/system-execution",
"//src/app/docs/system-impl",
"//src/app/docs/system-impl-wasm",
Expand Down
7 changes: 0 additions & 7 deletions src/app/docs/docs-routing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,6 @@ const routes: Routes = [
m => m.RuntimeRoutingModule,
),
},
{
path: 'runtime-builder',
loadChildren: () =>
import('./runtime-builder/runtime-builder-routing.module').then(
m => m.Runtime_BuilderRoutingModule,
),
},
{
path: 'runtime-implementations',
loadChildren: () =>
Expand Down
3 changes: 0 additions & 3 deletions src/app/docs/docs.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
</ecsact-sidenav-section>
<ecsact-sidenav-section title="Runtime">
<a routerLink="/docs/runtime" routerLinkActive="active">Runtime Library</a>
<a routerLink="/docs/runtime-builder" routerLinkActive="active"
>Runtime Builder</a
>
<a routerLink="/docs/runtime-implementations" routerLinkActive="active"
>Implementations</a
>
Expand Down
13 changes: 3 additions & 10 deletions src/app/docs/implementations/implementations.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,7 @@ <h1>Runtime Implementations</h1>
implementation must comply with. Which is to say that each implementation
<em>behaves</em> the same, but may <em>perform</em> different in terms of
execution speed and/or storage size. An implementation may even be tailored
to a set of ecsact files. For example, the
<a routerLink="/docs/runtime-builder">Ecsact Runtime Builder (RTB)</a> is a
utility for creating tailored runtimes for
<a [routerLink]="[]" fragment="generic-implementations"
>generic implementations</a
>.
to a set of ecsact files.
</p>

<h2 id="building-an-implementation">Building an Implementation</h2>
Expand Down Expand Up @@ -50,10 +45,8 @@ <h2 id="known-implementations">Known Implementations</h2>
<a [routerLink]="[]" fragment="runtime-config-generic"
>generic implementation</a
>
maintained by the Ecsact Dev Team and available as one of the
implementations in the
<a routerLink="/docs/runtime-builder">Ecsact Runtime Builder (RTB)</a>.
Built with the excellent library
maintained by the Ecsact Dev Team. Built with the <em>excellent</em> and
well known library
<a target="_blank" href="https://github.com/skypjack/entt"
><span class="i24">open_in_new</span> EnTT</a
>.
Expand Down
24 changes: 0 additions & 24 deletions src/app/docs/runtime-builder/BUILD.bazel

This file was deleted.

17 changes: 0 additions & 17 deletions src/app/docs/runtime-builder/runtime-builder-routing.module.ts

This file was deleted.

18 changes: 0 additions & 18 deletions src/app/docs/runtime-builder/runtime-builder.component.html

This file was deleted.

Empty file.
11 changes: 0 additions & 11 deletions src/app/docs/runtime-builder/runtime-builder.component.ts

This file was deleted.

29 changes: 8 additions & 21 deletions src/app/start/custom/start-custom.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,6 @@ <h3 id="ecsact-runtime-api-access">Ecsact Runtime API Access</h3>
gives the flexibility to control when and how runtime methods are called
without removing runtime capabilities.
</p>
<p>
If an integration provides
<a [routerLink]="[]" fragment="runtime-builder">runtime builder support</a>,
runtime access should be of the one produced by the runtime builder.
Otherwise a
<a routerLink="/docs/runtime" fragment="runtime-config-generic"
><span class="i24">article</span> generic runtime</a
>
may be used.
</p>
<h4 id="runtime-abstractions">Runtime Abstractions</h4>
<p>
Abstractions of the Ecsact Runtime API are encouraged to fit the practices
Expand Down Expand Up @@ -138,20 +128,17 @@ <h5 id="entity-sync" class="font-bold inline text-base">
all entities.
</li>
</ul>
<h3 id="runtime-builder">Runtime Builder</h3>
<h3 id="ecsact-build">Ecsact Build</h3>
<p>
It is highly recommended that an integration provide a convenient way to
build an Ecsact Runtime shared library.
build an Ecsact Runtime shared library. Integration should be as simple as
collecting all the <code>.ecsact</code> files and executing
<code>ecsact build</code> with said ecsact files. Additionally providing a
convenient way for the user to select a build recipe is encouraged.
</p>
<p>
The
<a routerLink="/docs/runtime-builder"
><span class="i24">article</span> Ecsact Runtime Builder (RTB)</a
>
is an open source command line utility that makes it easy to build an Ecsact
Runtime shared library. Integrations are encouraged to use the Ecsact RTB
CLI to simplify runtime build support. Conveniently the Ecsact RTB CLI
outputs it's progress and prompts in JSON which should be easily parsable in
any language, engine, or framework.
<code>ecsact build</code> can be configured to output JSON that you should
able to easily read when making your integration. See
<code>ecsact build --help</code> for the available flags.
</p>
</article>
6 changes: 0 additions & 6 deletions src/search/searchable-page-infos.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,6 @@ export const searchablePageInfos: {[key: string]: PageInfo | undefined} = {
keywords: [],
title: 'Ecsact Runtime',
},
'/docs/runtime-builder': {
category: PageCategory.Documentation,
description: '',
keywords: [],
title: 'Ecsact Runtime Builder',
},
'/docs/runtime-implementations': {
category: PageCategory.Documentation,
description: '',
Expand Down