-
-
Notifications
You must be signed in to change notification settings - Fork 151
/
README.md
191 lines (146 loc) · 6.12 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<!-- This file is generated - DO NOT EDIT! -->
<!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
# ![@thi.ng/ecs](https://media.thi.ng/umbrella/banners-20230807/thing-ecs.svg?9d9079ab)
[![npm version](https://img.shields.io/npm/v/@thi.ng/ecs.svg)](https://www.npmjs.com/package/@thi.ng/ecs)
![npm downloads](https://img.shields.io/npm/dm/@thi.ng/ecs.svg)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
> [!NOTE]
> This is one of 199 standalone projects, maintained as part
> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
> and anti-framework.
>
> 🚀 Please help me to work full-time on these projects by [sponsoring me on
> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
- [About](#about)
- [Status](#status)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [Usage examples](#usage-examples)
- [API](#api)
- [Basic concepts](#basic-concepts)
- [Authors](#authors)
- [License](#license)
## About
Entity Component System based around typed arrays & sparse sets.
- Entities are merely numeric identifiers
- Component types:
- Numeric / vectors are stored as typed array views with customizable striding
- arbitrary JS values are stored in vanilla JS arrays
- Component grouping w/ optional group ownership to allow re-ordering
components for optimized iteration
- Systems are plain functions
- Configurable caching of component views: LRU, Unbounded, Null (no-cache)
## Status
**ALPHA** - bleeding edge / work-in-progress
[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Becs%5D+in%3Atitle)
## Installation
```bash
yarn add @thi.ng/ecs
```
ESM import:
```ts
import * as ecs from "@thi.ng/ecs";
```
Browser ESM import:
```html
<script type="module" src="https://esm.run/@thi.ng/ecs"></script>
```
[JSDelivr documentation](https://www.jsdelivr.com/)
For Node.js REPL:
```js
const ecs = await import("@thi.ng/ecs");
```
Package sizes (brotli'd, pre-treeshake): ESM: 3.17 KB
## Dependencies
- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
- [@thi.ng/associative](https://github.com/thi-ng/umbrella/tree/develop/packages/associative)
- [@thi.ng/binary](https://github.com/thi-ng/umbrella/tree/develop/packages/binary)
- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
- [@thi.ng/dcons](https://github.com/thi-ng/umbrella/tree/develop/packages/dcons)
- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
- [@thi.ng/idgen](https://github.com/thi-ng/umbrella/tree/develop/packages/idgen)
- [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
- [@thi.ng/malloc](https://github.com/thi-ng/umbrella/tree/develop/packages/malloc)
- [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers)
- [tslib](https://www.typescriptlang.org/)
Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
## Usage examples
One project in this repo's
[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
directory is using this package:
| Screenshot | Description | Live demo | Source |
|:--------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|:----------------------------------------------|:---------------------------------------------------------------------------|
| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/soa-ecs-100k.png" width="240"/> | Entity Component System w/ 100k 3D particles | [Demo](https://demo.thi.ng/umbrella/soa-ecs/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/soa-ecs) |
## API
[Generated API docs](https://docs.thi.ng/umbrella/ecs/)
### Basic concepts
```ts
import { ECS } from "@thi.ng/ecs";
interface ComSpecs {
pos: Float32Array;
vel: Float32Array;
color: string;
}
// init ECS w/ given max number of entities
const ecs = new ECS<CompSpecs>(1000);
// define components (and their memory layout)
const pos = ecs.defComponent({
id: "pos",
type: Type.F32,
size: 2
});
const vel = ecs.defComponent({
id: "vel",
type: Type.F32,
size: 2,
stride: 4
default: () => [Math.random()*2-1, Math.random()*2-1]
});
// this component stores string values (not mem-mapped)
const color = ecs.defComponent({
id: "color",
default: () => ["red","green","blue"][(Math.random()*3)|0]
});
// define group of given components
// the group will obtain ownership of all by default, meaning
// it is allowed to re-order entities to optimize iteration performance
const group = ecs.defGroup([pos, vel, color]);
// add entities and associate them w/ different components
// if a component is part of a group, the group will be notified/updated
ecs.defEntity(["pos", "vel", "color"]);
ecs.defEntity([pos, vel]);
ecs.defEntity({
pos: [1, 2],
vel: [-1, 0],
color: "red"
});
// apply given function to each entity in the group
// note: entity (id=1) is NOT part of the group,
// since it doesn't have a `color` component...
group.forEach((x) => console.log(x));
// {
// id: 0,
// color: 'green',
// vel: Float32Array [ 0.16836269199848175, -0.36699679493904114 ],
// pos: Float32Array [ 0, 0 ]
// }
// {
// id: 2,
// color: 'blue',
// vel: Float32Array [ -0.7642428278923035, -0.43176573514938354 ],
// pos: Float32Array [ 0, 0 ]
// }
```
## Authors
- [Karsten Schmidt](https://thi.ng)
If this project contributes to an academic publication, please cite it as:
```bibtex
@misc{thing-ecs,
title = "@thi.ng/ecs",
author = "Karsten Schmidt",
note = "https://thi.ng/ecs",
year = 2019
}
```
## License
© 2019 - 2024 Karsten Schmidt // Apache License 2.0