Skip to content
This repository was archived by the owner on May 2, 2025. It is now read-only.

[developer] Getting Started with Typescript - first pass #96

Merged
merged 4 commits into from
Dec 28, 2023
Merged

[developer] Getting Started with Typescript - first pass #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
258ceed
note re segue
anselm Dec 27, 2023
d4622a3
removed bracket
anselm Dec 27, 2023
2e8317f
escaping brackets?
anselm Dec 27, 2023
ee6a18b
docusaurus disallows <> without escaping except in code blocks, also …
anselm Dec 28, 2023
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
2 changes: 1 addition & 1 deletion docs/01_gettingStarted/03_developer/00_intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ TODO: This page should contain:
-->
_This page will contain an introduction to the Getting Started: Developer guides._

_Programming in Ethereal Engine can be done through [Typescript](/docs/manual/developer/intro)._
_Programming in Ethereal Engine can be done through [Typescript](/docs/manual/developer/typescript/intro)._
_But the engine also has a NoCode alternative to programming, called [Behave Graph](/docs/manual/developer/behaveGraph/intro)._

14 changes: 9 additions & 5 deletions docs/01_gettingStarted/03_developer/02_typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,15 @@ NOTE: This page should contain:
- Guide: Teaches a new user how to program the Hero Project and be comfortable with EE project development.
- Segue: Lead the user into the Developer Manual
-->
_This guide will teach you how to get started programming with Ethereal Engine using Typescript._
_Visit the [Typescript: Introduction](/docs/manual/developer/typescript/intro) page for more details._
<!-- TODO: Add intro text as a mdx partial, instead of linking to the other page -->

## Overview

'Pong' is a simple multiplayer game in Ethereal Engine built using Typescript. It is an example of best practices for developers.
We're going to look at 'Pong', a multiplayer game that we've built in Ethereal Engine using Typescript. It is an example of best practices for developers.

## Installation and Running
## Installation and Running Pong

1) Ethereal Engine scans for projects mounted in the /packages/projects/projects sub-folder of Ethereal Engine. From scratch we can install Ethereal Engine itself and also register a sub project using the following:

Expand Down Expand Up @@ -105,7 +108,7 @@ export const PaddleState = defineState({
...
```

The defineState() method registers a collection of Record<> objects. A Record is a schema in a third party runtime schema definition language that Ethereal Engine uses. In this case the Record declares that this state object is a hashed collection of EntityUUID to { owner, handedness, gamEntityUUID } objects.
The defineState() method registers a collection of Record objects. A Record is a schema in a third party runtime schema definition language that Ethereal Engine uses.

### PaddleSystem: Introduction to Event Sourced State

Expand Down Expand Up @@ -208,8 +211,9 @@ The general flow is like so:

## PlateComponent

[tbd]

### PongComponent, PongGameSystem and PongPhysicsSystem

[tbd]

### Summary