antha 0.0.8 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -1
- package/dist/default-engine.d.ts +1 -2
- package/package.json +16 -17
package/README.md
CHANGED
|
@@ -1,9 +1,30 @@
|
|
|
1
1
|
# antha
|
|
2
2
|
|
|
3
|
-
An easy to use drop-in Antha engine with
|
|
3
|
+
An easy to use drop-in package containing the [Antha game engine](https://www.npmjs.com/package/@antha/engine) with a bunch of pre-built mods already setup.
|
|
4
|
+
|
|
5
|
+
## Included mods
|
|
6
|
+
|
|
7
|
+
- [@antha/asset](https://www.npmjs.com/package/@antha/asset): asset loading.
|
|
8
|
+
- [@antha/audio](https://www.npmjs.com/package/@antha/audio): audio loading and playback.
|
|
9
|
+
- [@antha/entity-2d](https://www.npmjs.com/package/@antha/entity-2d): 2D entities, rendering, and collision detection.
|
|
10
|
+
- [@antha/fps](https://www.npmjs.com/package/@antha/fps): on-screen frames-per-second counter.
|
|
11
|
+
- [@antha/graphics-2d](https://www.npmjs.com/package/@antha/graphics-2d): PixiJS application and canvas for rendering 2D graphics.
|
|
12
|
+
- [@antha/input](https://www.npmjs.com/package/@antha/input): keyboard and gamepad input detection and bindings.
|
|
4
13
|
|
|
5
14
|
## Install
|
|
6
15
|
|
|
7
16
|
```sh
|
|
8
17
|
npm i antha
|
|
9
18
|
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
<!-- example-link: src/readme-examples/creating-default-engine.example.ts -->
|
|
23
|
+
|
|
24
|
+
```TypeScript
|
|
25
|
+
import {createDefaultAnthaEngine} from 'antha';
|
|
26
|
+
|
|
27
|
+
const {engine} = createDefaultAnthaEngine();
|
|
28
|
+
|
|
29
|
+
engine.startLoop();
|
|
30
|
+
```
|
package/dist/default-engine.d.ts
CHANGED
|
@@ -5,8 +5,7 @@ import { type AnthaEntity2dModOptions, type AnthaEntity2dModState } from '@antha
|
|
|
5
5
|
import { type AnthaFpsModOptions } from '@antha/fps';
|
|
6
6
|
import { type AnthaGraphics2dModOptions, type AnthaGraphics2dModState } from '@antha/graphics-2d';
|
|
7
7
|
import { type AnthaInputBindingsModOptions, type AnthaInputBindingsModState, type AnthaReadRawInputModOptions, type AnthaReadRawInputModState } from '@antha/input';
|
|
8
|
-
import { type AnyObject } from '@augment-vir/common';
|
|
9
|
-
import { type EmptyObject } from 'type-fest';
|
|
8
|
+
import { type AnyObject, type EmptyObject } from '@augment-vir/common';
|
|
10
9
|
/**
|
|
11
10
|
* Options for {@link createDefaultAnthaEngine}, combined from all the default mods.
|
|
12
11
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "antha",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "A simple-to-use all-in-one Antha engine variant with default mods.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"vir",
|
|
@@ -35,28 +35,27 @@
|
|
|
35
35
|
"test:docs": "virmator docs check"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@augment-vir/assert": "^
|
|
39
|
-
"@augment-vir/common": "^
|
|
40
|
-
"type-fest": "^5.7.0"
|
|
38
|
+
"@augment-vir/assert": "^32.2.2",
|
|
39
|
+
"@augment-vir/common": "^32.2.2"
|
|
41
40
|
},
|
|
42
41
|
"devDependencies": {
|
|
43
|
-
"@
|
|
44
|
-
"@
|
|
45
|
-
"@web/
|
|
46
|
-
"@web/test-runner
|
|
42
|
+
"@antha/web-test-runner-plugin-pixi": "^0.1.1",
|
|
43
|
+
"@augment-vir/test": "^32.2.2",
|
|
44
|
+
"@web/dev-server-esbuild": "^2.0.0",
|
|
45
|
+
"@web/test-runner": "^1.0.0",
|
|
46
|
+
"@web/test-runner-playwright": "^1.0.0",
|
|
47
47
|
"istanbul-smart-text-reporter": "^1.1.5",
|
|
48
48
|
"typescript": "^6.0.3",
|
|
49
|
-
"vite": "^8.
|
|
50
|
-
"web-test-runner-plugin-pixi": "^0.0.2"
|
|
49
|
+
"vite": "^8.2.1"
|
|
51
50
|
},
|
|
52
51
|
"peerDependencies": {
|
|
53
|
-
"@antha/asset": "^0.
|
|
54
|
-
"@antha/audio": "^0.
|
|
55
|
-
"@antha/engine": "^0.
|
|
56
|
-
"@antha/entity-2d": "^0.
|
|
57
|
-
"@antha/fps": "^0.
|
|
58
|
-
"@antha/graphics-2d": "^0.
|
|
59
|
-
"@antha/input": "^0.
|
|
52
|
+
"@antha/asset": "^0.1.1",
|
|
53
|
+
"@antha/audio": "^0.1.1",
|
|
54
|
+
"@antha/engine": "^0.1.1",
|
|
55
|
+
"@antha/entity-2d": "^0.1.1",
|
|
56
|
+
"@antha/fps": "^0.1.1",
|
|
57
|
+
"@antha/graphics-2d": "^0.1.1",
|
|
58
|
+
"@antha/input": "^0.1.1"
|
|
60
59
|
},
|
|
61
60
|
"engines": {
|
|
62
61
|
"node": ">=22"
|