@auraindustry/aurajs 0.0.2 → 0.0.4

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 ADDED
@@ -0,0 +1,52 @@
1
+ # @auraindustry/aurajs
2
+
3
+ > Alpha status: AuraJS is currently in alpha and is not safe for production use yet.
4
+
5
+ Write games in JavaScript and build native binaries for macOS, Linux, and Windows.
6
+
7
+ ## Create A New Game
8
+
9
+ Run the published package directly:
10
+
11
+ ```bash
12
+ npm exec --yes --package @auraindustry/aurajs -- aura create my-game
13
+ cd my-game
14
+ npm run dev
15
+ ```
16
+
17
+ If you already use AuraMaxx, the same scaffold flow is available there:
18
+
19
+ ```bash
20
+ npx auramaxx create my-game
21
+ cd my-game
22
+ npm run dev
23
+ ```
24
+
25
+ If you prefer a global install:
26
+
27
+ ```bash
28
+ npm install -g @auraindustry/aurajs
29
+ aura create my-game
30
+ ```
31
+
32
+ ## Publish And Play
33
+
34
+ In a scaffolded AuraJS game:
35
+
36
+ ```bash
37
+ npm run publish
38
+ npm run play
39
+ ```
40
+
41
+ `npm run publish` maps to `npx auramaxx publish` in generated projects.
42
+
43
+ ## API Surfaces
44
+
45
+ - React embedding: `@auraindustry/aurajs/react`
46
+ - Web runtime helpers: `@auraindustry/aurajs/web`
47
+
48
+ ## Docs
49
+
50
+ - Repo README: <https://github.com/Aura-Industry/aurajs>
51
+ - Core API: <https://github.com/Aura-Industry/aurajs/blob/main/packages/aurascript/docs/api-contract-v1.md>
52
+ - 3D API: <https://github.com/Aura-Industry/aurajs/blob/main/packages/aurascript/docs/api-contract-3d-v2.md>
package/package.json CHANGED
@@ -1,8 +1,13 @@
1
1
  {
2
2
  "name": "@auraindustry/aurajs",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "Write games in JavaScript, build native binaries.",
5
5
  "type": "module",
6
+ "exports": {
7
+ "./react": "./src/react/index.mjs",
8
+ "./web": "./src/web-api.mjs",
9
+ "./package.json": "./package.json"
10
+ },
6
11
  "bin": {
7
12
  "aura": "./src/cli.mjs"
8
13
  },
@@ -24,6 +29,13 @@
24
29
  "test:benchmark": "node --test ./test/perf-benchmark.test.mjs",
25
30
  "test:e2e": "node --test ./test/e2e-flow.test.mjs"
26
31
  },
32
+ "peerDependencies": {
33
+ "react": ">=18"
34
+ },
35
+ "devDependencies": {
36
+ "react": "^18.3.1",
37
+ "react-test-renderer": "^18.3.1"
38
+ },
27
39
  "optionalDependencies": {
28
40
  "@aurajs/darwin-arm64": "github:Aura-Industry/aurajs-darwin-arm64",
29
41
  "@aurajs/darwin-x64": "github:Aura-Industry/aurajs-darwin-x64",