valence-cli 1.2.8 → 1.3.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 +57 -43
- package/README.original.md +57 -43
- package/dist/README.md +57 -43
- package/dist/commands/add.d.ts.map +1 -1
- package/dist/commands/add.js +93 -1
- package/dist/commands/add.js.map +1 -1
- package/dist/commands/build.d.ts.map +1 -1
- package/dist/commands/build.js +115 -1
- package/dist/commands/build.js.map +1 -1
- package/dist/commands/codegen.js +42 -1
- package/dist/commands/doctor.d.ts.map +1 -1
- package/dist/commands/doctor.js +65 -1
- package/dist/commands/doctor.js.map +1 -1
- package/dist/commands/features/assets.d.ts +6 -0
- package/dist/commands/features/assets.d.ts.map +1 -0
- package/dist/commands/features/assets.js +113 -0
- package/dist/commands/features/assets.js.map +1 -0
- package/dist/commands/features/audio.d.ts +2 -0
- package/dist/commands/features/audio.d.ts.map +1 -0
- package/dist/commands/features/audio.js +17 -0
- package/dist/commands/features/audio.js.map +1 -0
- package/dist/commands/features/input.d.ts +2 -0
- package/dist/commands/features/input.d.ts.map +1 -0
- package/dist/commands/features/input.js +13 -0
- package/dist/commands/features/input.js.map +1 -0
- package/dist/commands/features/multiplayer.d.ts +2 -0
- package/dist/commands/features/multiplayer.d.ts.map +1 -0
- package/dist/commands/features/multiplayer.js +81 -0
- package/dist/commands/features/multiplayer.js.map +1 -0
- package/dist/commands/features/native.d.ts +2 -0
- package/dist/commands/features/native.d.ts.map +1 -0
- package/dist/commands/features/native.js +83 -0
- package/dist/commands/features/native.js.map +1 -0
- package/dist/commands/features/physics.d.ts +2 -0
- package/dist/commands/features/physics.d.ts.map +1 -0
- package/dist/commands/features/physics.js +44 -0
- package/dist/commands/features/physics.js.map +1 -0
- package/dist/commands/features/pipeline.d.ts +2 -0
- package/dist/commands/features/pipeline.d.ts.map +1 -0
- package/dist/commands/features/pipeline.js +28 -0
- package/dist/commands/features/pipeline.js.map +1 -0
- package/dist/commands/features/settings.d.ts +2 -0
- package/dist/commands/features/settings.d.ts.map +1 -0
- package/dist/commands/features/settings.js +13 -0
- package/dist/commands/features/settings.js.map +1 -0
- package/dist/commands/features/state.d.ts +2 -0
- package/dist/commands/features/state.d.ts.map +1 -0
- package/dist/commands/features/state.js +12 -0
- package/dist/commands/features/state.js.map +1 -0
- package/dist/commands/features/storage.d.ts +2 -0
- package/dist/commands/features/storage.d.ts.map +1 -0
- package/dist/commands/features/storage.js +33 -0
- package/dist/commands/features/storage.js.map +1 -0
- package/dist/commands/features/tailwind.d.ts +2 -0
- package/dist/commands/features/tailwind.d.ts.map +1 -0
- package/dist/commands/features/tailwind.js +46 -0
- package/dist/commands/features/tailwind.js.map +1 -0
- package/dist/commands/generate.d.ts.map +1 -1
- package/dist/commands/generate.js +205 -1
- package/dist/commands/generate.js.map +1 -1
- package/dist/commands/lifecycle.d.ts.map +1 -1
- package/dist/commands/lifecycle.js +45 -1
- package/dist/commands/lifecycle.js.map +1 -1
- package/dist/commands/new-helpers.d.ts +12 -0
- package/dist/commands/new-helpers.d.ts.map +1 -0
- package/dist/commands/new-helpers.js +61 -0
- package/dist/commands/new-helpers.js.map +1 -0
- package/dist/commands/new.d.ts +1 -0
- package/dist/commands/new.d.ts.map +1 -1
- package/dist/commands/new.js +173 -1
- package/dist/commands/new.js.map +1 -1
- package/dist/commands/publish.js +86 -1
- package/dist/commands/template.d.ts.map +1 -1
- package/dist/commands/template.js +259 -1
- package/dist/commands/template.js.map +1 -1
- package/dist/commands/verify.d.ts +2 -0
- package/dist/commands/verify.d.ts.map +1 -0
- package/dist/commands/verify.js +80 -0
- package/dist/commands/verify.js.map +1 -0
- package/dist/constants/versions.d.ts +41 -0
- package/dist/constants/versions.d.ts.map +1 -0
- package/dist/constants/versions.js +41 -0
- package/dist/constants/versions.js.map +1 -0
- package/dist/index.js +107 -1
- package/dist/index.js.map +1 -1
- package/dist/templates/angular.d.ts +2 -2
- package/dist/templates/angular.d.ts.map +1 -1
- package/dist/templates/angular.js +375 -1
- package/dist/templates/angular.js.map +1 -1
- package/dist/templates/audio.d.ts +2 -0
- package/dist/templates/audio.d.ts.map +1 -0
- package/dist/templates/audio.js +95 -0
- package/dist/templates/audio.js.map +1 -0
- package/dist/templates/components.js +54 -1
- package/dist/templates/config.js +26 -1
- package/dist/templates/electron.js +124 -1
- package/dist/templates/index.d.ts +7 -0
- package/dist/templates/index.d.ts.map +1 -1
- package/dist/templates/index.js +12 -1
- package/dist/templates/index.js.map +1 -1
- package/dist/templates/input.d.ts +2 -0
- package/dist/templates/input.d.ts.map +1 -0
- package/dist/templates/input.js +159 -0
- package/dist/templates/input.js.map +1 -0
- package/dist/templates/multiplayer.d.ts +7 -0
- package/dist/templates/multiplayer.d.ts.map +1 -0
- package/dist/templates/multiplayer.js +151 -0
- package/dist/templates/multiplayer.js.map +1 -0
- package/dist/templates/native.d.ts +4 -0
- package/dist/templates/native.d.ts.map +1 -0
- package/dist/templates/native.js +40 -0
- package/dist/templates/native.js.map +1 -0
- package/dist/templates/phaser-scene.d.ts +2 -0
- package/dist/templates/phaser-scene.d.ts.map +1 -0
- package/dist/templates/phaser-scene.js +27 -0
- package/dist/templates/phaser-scene.js.map +1 -0
- package/dist/templates/phaser.d.ts +2 -0
- package/dist/templates/phaser.d.ts.map +1 -0
- package/dist/templates/phaser.js +147 -0
- package/dist/templates/phaser.js.map +1 -0
- package/dist/templates/settings.d.ts +2 -0
- package/dist/templates/settings.d.ts.map +1 -0
- package/dist/templates/settings.js +66 -0
- package/dist/templates/settings.js.map +1 -0
- package/dist/templates/state.d.ts +2 -0
- package/dist/templates/state.d.ts.map +1 -0
- package/dist/templates/state.js +35 -0
- package/dist/templates/state.js.map +1 -0
- package/dist/templates/storage.d.ts +4 -0
- package/dist/templates/storage.d.ts.map +1 -0
- package/dist/templates/storage.js +121 -0
- package/dist/templates/storage.js.map +1 -0
- package/dist/templates.d.ts +2 -0
- package/dist/templates.d.ts.map +1 -1
- package/dist/templates.js +4 -1
- package/dist/templates.js.map +1 -1
- package/dist/utils/ast/modify-app-component.d.ts +2 -0
- package/dist/utils/ast/modify-app-component.d.ts.map +1 -0
- package/dist/utils/ast/modify-app-component.js +136 -0
- package/dist/utils/ast/modify-app-component.js.map +1 -0
- package/dist/utils/ast.d.ts +20 -0
- package/dist/utils/ast.d.ts.map +1 -0
- package/dist/utils/ast.js +95 -0
- package/dist/utils/ast.js.map +1 -0
- package/dist/utils/configurators/angular.d.ts +2 -0
- package/dist/utils/configurators/angular.d.ts.map +1 -0
- package/dist/utils/configurators/angular.js +28 -0
- package/dist/utils/configurators/angular.js.map +1 -0
- package/dist/utils/configurators/electron.d.ts +2 -0
- package/dist/utils/configurators/electron.d.ts.map +1 -0
- package/dist/utils/configurators/electron.js +12 -0
- package/dist/utils/configurators/electron.js.map +1 -0
- package/dist/utils/configurators/meta.d.ts +5 -0
- package/dist/utils/configurators/meta.d.ts.map +1 -0
- package/dist/utils/configurators/meta.js +14 -0
- package/dist/utils/configurators/meta.js.map +1 -0
- package/dist/utils/configurators/package.d.ts +5 -0
- package/dist/utils/configurators/package.d.ts.map +1 -0
- package/dist/utils/configurators/package.js +23 -0
- package/dist/utils/configurators/package.js.map +1 -0
- package/dist/utils/engine.d.ts +9 -0
- package/dist/utils/engine.d.ts.map +1 -0
- package/dist/utils/engine.js +43 -0
- package/dist/utils/engine.js.map +1 -0
- package/dist/utils/files.d.ts +17 -0
- package/dist/utils/files.d.ts.map +1 -0
- package/dist/utils/files.js +41 -0
- package/dist/utils/files.js.map +1 -0
- package/dist/utils/logger.js +65 -1
- package/dist/utils/pipeline.d.ts +2 -0
- package/dist/utils/pipeline.d.ts.map +1 -0
- package/dist/utils/pipeline.js +69 -0
- package/dist/utils/pipeline.js.map +1 -0
- package/dist/utils/update.js +33 -1
- package/dist/utils/validation.js +12 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -35,12 +35,16 @@ valence start
|
|
|
35
35
|
## 🛠 Commands
|
|
36
36
|
|
|
37
37
|
### `valence new <name>`
|
|
38
|
-
Scaffolds a new project
|
|
38
|
+
Scaffolds a new high-performance project. You will be prompted to select your engine:
|
|
39
|
+
|
|
40
|
+
* **3D (Babylon.js)**: Full 3D capabilities with Havok Physics, XR, and Inspector support.
|
|
41
|
+
* **2D (Phaser)**: Fast 2D game engine with configured scenes and arcade physics.
|
|
42
|
+
|
|
43
|
+
**Both environments include:**
|
|
39
44
|
- **Angular**: Latest CLI, SCSS, Routing.
|
|
40
45
|
- **Electron**: TypeScript Main/Preload processes, securely configured.
|
|
41
|
-
- **
|
|
42
|
-
- **
|
|
43
|
-
- **Pro Template**: Includes a rotating wireframe plane, FPS counter, and real-time Camera Rotation (XYZ) tracker with a premium glassmorphic UI.
|
|
46
|
+
- **Forge**: Configured for building `.exe` / `.zip` / installers.
|
|
47
|
+
- **Valence UI**: Premium glassmorphic HUD with FPS and status tracking.
|
|
44
48
|
|
|
45
49
|
### `valence start`
|
|
46
50
|
Runs the application in **Development Mode**:
|
|
@@ -55,6 +59,9 @@ Compiles the application for **Production**:
|
|
|
55
59
|
- Optimizes assets.
|
|
56
60
|
- Enforces relative paths (`baseHref="./"`) for Electron compatibility.
|
|
57
61
|
|
|
62
|
+
### `valence test`
|
|
63
|
+
Runs the project's automated test suite (if configured).
|
|
64
|
+
|
|
58
65
|
### `valence package`
|
|
59
66
|
Packages the application for distribution:
|
|
60
67
|
- Runs `valence build`.
|
|
@@ -63,60 +70,67 @@ Packages the application for distribution:
|
|
|
63
70
|
|
|
64
71
|
### `valence publish`
|
|
65
72
|
Automates the release pipeline:
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
73
|
+
- Bumps project version (patch).
|
|
74
|
+
- Updates `README.md` version badges.
|
|
75
|
+
- Builds & Packages.
|
|
76
|
+
- Generates `RELEASES_README.md` entry.
|
|
77
|
+
- Publishes via Electron Forge.
|
|
71
78
|
|
|
72
|
-
|
|
73
|
-
*Alias: `valence g scene <name>`*
|
|
74
|
-
Scaffolds a new **Babylon.js Scene component** in `src/app/scenes/<name>`:
|
|
75
|
-
- Pre-wired `Engine` and `Scene` creation.
|
|
76
|
-
- Includes Camera, Light, and Resize event handling.
|
|
77
|
-
- Ready for 3D logic immediately.
|
|
79
|
+
---
|
|
78
80
|
|
|
79
|
-
|
|
81
|
+
## 🎮 Gameplay Services
|
|
80
82
|
|
|
81
|
-
|
|
83
|
+
Valence can automatically inject core game systems into your project.
|
|
82
84
|
|
|
83
|
-
|
|
85
|
+
### `valence add <feature>`
|
|
84
86
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
-
|
|
87
|
+
#### Core Systems
|
|
88
|
+
* **`input`**: Unified Action Mapping (Keyboard/Gamepad) via Angular Signals.
|
|
89
|
+
* **`audio`**: Channel-based audio manager (Master/Music/SFX) using Howler.js.
|
|
90
|
+
* **`storage`**: Secure, atomic file I/O for save games (Write-Temp-Rename pattern) via Electron IPC.
|
|
91
|
+
* **`settings`**: Centralized configuration manager (Audio/Graphics) persisted to storage.
|
|
92
|
+
* **`state`**: Strict Game State Machine (Boot, Menu, Gameplay, Paused) via Signals.
|
|
88
93
|
|
|
89
|
-
|
|
94
|
+
#### 3D Features (Babylon.js)
|
|
95
|
+
* **`physics`**: Installs Havok engine (WASM) & initializes physics.
|
|
96
|
+
* **`inspector`**: Installs & binds Babylon Inspector to `Ctrl+I`.
|
|
97
|
+
* **`gui`**: Installs `lil-gui` debug panel.
|
|
98
|
+
* **`materials`**: Installs `@babylonjs/materials`.
|
|
99
|
+
* **`skybox`**: Creates environmental skybox.
|
|
100
|
+
* **`xr`**: Initializes WebXR (VR/AR) experience.
|
|
90
101
|
|
|
91
|
-
|
|
102
|
+
#### Universal Features
|
|
103
|
+
* **`tailwind`**: Configures TailwindCSS with Angular.
|
|
104
|
+
* **`multiplayer`**: Scaffolds Colyseus server & client.
|
|
105
|
+
* **`pipeline`**: Enables Asset Optimization Pipeline (sharp).
|
|
106
|
+
* **`native`**: Scaffolds Rust (Neon) native module.
|
|
92
107
|
|
|
93
|
-
|
|
94
|
-
- `inspector`: Installs `@babylonjs/inspector` and binds `Ctrl+I` to toggle the dedicated 3D debugger overlay.
|
|
95
|
-
- `gui`: Installs `lil-gui` and creates a debug panel for tweaking parameters at runtime.
|
|
96
|
-
- `materials`: Installs `@babylonjs/materials`, enabling Grid, Gradient, and other advanced materials.
|
|
97
|
-
- `skybox`: Automatically creates a large skybox mesh to provide environmental context.
|
|
98
|
-
- `xr`: Initializes WebXR default experience (Teleportation + Controller support) for VR/AR.
|
|
99
|
-
- `tailwind`: Configures TailwindCSS with Angular (PostCSS, Config, Styles).
|
|
108
|
+
---
|
|
100
109
|
|
|
101
|
-
|
|
110
|
+
## 🎲 Generators
|
|
102
111
|
|
|
103
|
-
|
|
112
|
+
### `valence generate scene <name>`
|
|
113
|
+
*Alias: `valence g scene <name>`*
|
|
114
|
+
Scaffolds a new Scene component:
|
|
115
|
+
* **3D**: Pre-wired Babylon.js `Scene` with Camera/Light/Resize handling.
|
|
116
|
+
* **2D**: Pre-wired Phaser `Scene` class with lifecycle methods.
|
|
104
117
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
118
|
+
### `valence generate bridge <name>`
|
|
119
|
+
*Alias: `valence g bridge <name>`*
|
|
120
|
+
Generates a type-safe IPC communication channel:
|
|
121
|
+
* **Main Process**: Registers `ipcMain.handle`.
|
|
122
|
+
* **Preload**: Exposes `contextBridge` API.
|
|
123
|
+
* **Service**: Creates Angular service wrapper.
|
|
110
124
|
|
|
111
125
|
### `valence codegen assets`
|
|
126
|
+
Scans `src/assets` and generates typed constants in `core/asset-keys.ts` for IntelliSense.
|
|
112
127
|
|
|
113
|
-
|
|
128
|
+
---
|
|
114
129
|
|
|
115
|
-
|
|
130
|
+
## 🩺 Diagnostics
|
|
116
131
|
|
|
117
132
|
### `valence doctor`
|
|
133
|
+
Diagnoses your development environment (Node, NPM, Git).
|
|
118
134
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
- Verifies Git installation.
|
|
122
|
-
- Checks for global Angular CLI (optional).
|
|
135
|
+
### `valence verify`
|
|
136
|
+
Performs deep health check of project structure and configuration.
|
package/README.original.md
CHANGED
|
@@ -35,12 +35,16 @@ valence start
|
|
|
35
35
|
## 🛠 Commands
|
|
36
36
|
|
|
37
37
|
### `valence new <name>`
|
|
38
|
-
Scaffolds a new project
|
|
38
|
+
Scaffolds a new high-performance project. You will be prompted to select your engine:
|
|
39
|
+
|
|
40
|
+
* **3D (Babylon.js)**: Full 3D capabilities with Havok Physics, XR, and Inspector support.
|
|
41
|
+
* **2D (Phaser)**: Fast 2D game engine with configured scenes and arcade physics.
|
|
42
|
+
|
|
43
|
+
**Both environments include:**
|
|
39
44
|
- **Angular**: Latest CLI, SCSS, Routing.
|
|
40
45
|
- **Electron**: TypeScript Main/Preload processes, securely configured.
|
|
41
|
-
- **
|
|
42
|
-
- **
|
|
43
|
-
- **Pro Template**: Includes a rotating wireframe plane, FPS counter, and real-time Camera Rotation (XYZ) tracker with a premium glassmorphic UI.
|
|
46
|
+
- **Forge**: Configured for building `.exe` / `.zip` / installers.
|
|
47
|
+
- **Valence UI**: Premium glassmorphic HUD with FPS and status tracking.
|
|
44
48
|
|
|
45
49
|
### `valence start`
|
|
46
50
|
Runs the application in **Development Mode**:
|
|
@@ -55,6 +59,9 @@ Compiles the application for **Production**:
|
|
|
55
59
|
- Optimizes assets.
|
|
56
60
|
- Enforces relative paths (`baseHref="./"`) for Electron compatibility.
|
|
57
61
|
|
|
62
|
+
### `valence test`
|
|
63
|
+
Runs the project's automated test suite (if configured).
|
|
64
|
+
|
|
58
65
|
### `valence package`
|
|
59
66
|
Packages the application for distribution:
|
|
60
67
|
- Runs `valence build`.
|
|
@@ -63,60 +70,67 @@ Packages the application for distribution:
|
|
|
63
70
|
|
|
64
71
|
### `valence publish`
|
|
65
72
|
Automates the release pipeline:
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
73
|
+
- Bumps project version (patch).
|
|
74
|
+
- Updates `README.md` version badges.
|
|
75
|
+
- Builds & Packages.
|
|
76
|
+
- Generates `RELEASES_README.md` entry.
|
|
77
|
+
- Publishes via Electron Forge.
|
|
71
78
|
|
|
72
|
-
|
|
73
|
-
*Alias: `valence g scene <name>`*
|
|
74
|
-
Scaffolds a new **Babylon.js Scene component** in `src/app/scenes/<name>`:
|
|
75
|
-
- Pre-wired `Engine` and `Scene` creation.
|
|
76
|
-
- Includes Camera, Light, and Resize event handling.
|
|
77
|
-
- Ready for 3D logic immediately.
|
|
79
|
+
---
|
|
78
80
|
|
|
79
|
-
|
|
81
|
+
## 🎮 Gameplay Services
|
|
80
82
|
|
|
81
|
-
|
|
83
|
+
Valence can automatically inject core game systems into your project.
|
|
82
84
|
|
|
83
|
-
|
|
85
|
+
### `valence add <feature>`
|
|
84
86
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
-
|
|
87
|
+
#### Core Systems
|
|
88
|
+
* **`input`**: Unified Action Mapping (Keyboard/Gamepad) via Angular Signals.
|
|
89
|
+
* **`audio`**: Channel-based audio manager (Master/Music/SFX) using Howler.js.
|
|
90
|
+
* **`storage`**: Secure, atomic file I/O for save games (Write-Temp-Rename pattern) via Electron IPC.
|
|
91
|
+
* **`settings`**: Centralized configuration manager (Audio/Graphics) persisted to storage.
|
|
92
|
+
* **`state`**: Strict Game State Machine (Boot, Menu, Gameplay, Paused) via Signals.
|
|
88
93
|
|
|
89
|
-
|
|
94
|
+
#### 3D Features (Babylon.js)
|
|
95
|
+
* **`physics`**: Installs Havok engine (WASM) & initializes physics.
|
|
96
|
+
* **`inspector`**: Installs & binds Babylon Inspector to `Ctrl+I`.
|
|
97
|
+
* **`gui`**: Installs `lil-gui` debug panel.
|
|
98
|
+
* **`materials`**: Installs `@babylonjs/materials`.
|
|
99
|
+
* **`skybox`**: Creates environmental skybox.
|
|
100
|
+
* **`xr`**: Initializes WebXR (VR/AR) experience.
|
|
90
101
|
|
|
91
|
-
|
|
102
|
+
#### Universal Features
|
|
103
|
+
* **`tailwind`**: Configures TailwindCSS with Angular.
|
|
104
|
+
* **`multiplayer`**: Scaffolds Colyseus server & client.
|
|
105
|
+
* **`pipeline`**: Enables Asset Optimization Pipeline (sharp).
|
|
106
|
+
* **`native`**: Scaffolds Rust (Neon) native module.
|
|
92
107
|
|
|
93
|
-
|
|
94
|
-
- `inspector`: Installs `@babylonjs/inspector` and binds `Ctrl+I` to toggle the dedicated 3D debugger overlay.
|
|
95
|
-
- `gui`: Installs `lil-gui` and creates a debug panel for tweaking parameters at runtime.
|
|
96
|
-
- `materials`: Installs `@babylonjs/materials`, enabling Grid, Gradient, and other advanced materials.
|
|
97
|
-
- `skybox`: Automatically creates a large skybox mesh to provide environmental context.
|
|
98
|
-
- `xr`: Initializes WebXR default experience (Teleportation + Controller support) for VR/AR.
|
|
99
|
-
- `tailwind`: Configures TailwindCSS with Angular (PostCSS, Config, Styles).
|
|
108
|
+
---
|
|
100
109
|
|
|
101
|
-
|
|
110
|
+
## 🎲 Generators
|
|
102
111
|
|
|
103
|
-
|
|
112
|
+
### `valence generate scene <name>`
|
|
113
|
+
*Alias: `valence g scene <name>`*
|
|
114
|
+
Scaffolds a new Scene component:
|
|
115
|
+
* **3D**: Pre-wired Babylon.js `Scene` with Camera/Light/Resize handling.
|
|
116
|
+
* **2D**: Pre-wired Phaser `Scene` class with lifecycle methods.
|
|
104
117
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
118
|
+
### `valence generate bridge <name>`
|
|
119
|
+
*Alias: `valence g bridge <name>`*
|
|
120
|
+
Generates a type-safe IPC communication channel:
|
|
121
|
+
* **Main Process**: Registers `ipcMain.handle`.
|
|
122
|
+
* **Preload**: Exposes `contextBridge` API.
|
|
123
|
+
* **Service**: Creates Angular service wrapper.
|
|
110
124
|
|
|
111
125
|
### `valence codegen assets`
|
|
126
|
+
Scans `src/assets` and generates typed constants in `core/asset-keys.ts` for IntelliSense.
|
|
112
127
|
|
|
113
|
-
|
|
128
|
+
---
|
|
114
129
|
|
|
115
|
-
|
|
130
|
+
## 🩺 Diagnostics
|
|
116
131
|
|
|
117
132
|
### `valence doctor`
|
|
133
|
+
Diagnoses your development environment (Node, NPM, Git).
|
|
118
134
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
- Verifies Git installation.
|
|
122
|
-
- Checks for global Angular CLI (optional).
|
|
135
|
+
### `valence verify`
|
|
136
|
+
Performs deep health check of project structure and configuration.
|
package/dist/README.md
CHANGED
|
@@ -35,12 +35,16 @@ valence start
|
|
|
35
35
|
## 🛠 Commands
|
|
36
36
|
|
|
37
37
|
### `valence new <name>`
|
|
38
|
-
Scaffolds a new project
|
|
38
|
+
Scaffolds a new high-performance project. You will be prompted to select your engine:
|
|
39
|
+
|
|
40
|
+
* **3D (Babylon.js)**: Full 3D capabilities with Havok Physics, XR, and Inspector support.
|
|
41
|
+
* **2D (Phaser)**: Fast 2D game engine with configured scenes and arcade physics.
|
|
42
|
+
|
|
43
|
+
**Both environments include:**
|
|
39
44
|
- **Angular**: Latest CLI, SCSS, Routing.
|
|
40
45
|
- **Electron**: TypeScript Main/Preload processes, securely configured.
|
|
41
|
-
- **
|
|
42
|
-
- **
|
|
43
|
-
- **Pro Template**: Includes a rotating wireframe plane, FPS counter, and real-time Camera Rotation (XYZ) tracker with a premium glassmorphic UI.
|
|
46
|
+
- **Forge**: Configured for building `.exe` / `.zip` / installers.
|
|
47
|
+
- **Valence UI**: Premium glassmorphic HUD with FPS and status tracking.
|
|
44
48
|
|
|
45
49
|
### `valence start`
|
|
46
50
|
Runs the application in **Development Mode**:
|
|
@@ -55,6 +59,9 @@ Compiles the application for **Production**:
|
|
|
55
59
|
- Optimizes assets.
|
|
56
60
|
- Enforces relative paths (`baseHref="./"`) for Electron compatibility.
|
|
57
61
|
|
|
62
|
+
### `valence test`
|
|
63
|
+
Runs the project's automated test suite (if configured).
|
|
64
|
+
|
|
58
65
|
### `valence package`
|
|
59
66
|
Packages the application for distribution:
|
|
60
67
|
- Runs `valence build`.
|
|
@@ -63,60 +70,67 @@ Packages the application for distribution:
|
|
|
63
70
|
|
|
64
71
|
### `valence publish`
|
|
65
72
|
Automates the release pipeline:
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
73
|
+
- Bumps project version (patch).
|
|
74
|
+
- Updates `README.md` version badges.
|
|
75
|
+
- Builds & Packages.
|
|
76
|
+
- Generates `RELEASES_README.md` entry.
|
|
77
|
+
- Publishes via Electron Forge.
|
|
71
78
|
|
|
72
|
-
|
|
73
|
-
*Alias: `valence g scene <name>`*
|
|
74
|
-
Scaffolds a new **Babylon.js Scene component** in `src/app/scenes/<name>`:
|
|
75
|
-
- Pre-wired `Engine` and `Scene` creation.
|
|
76
|
-
- Includes Camera, Light, and Resize event handling.
|
|
77
|
-
- Ready for 3D logic immediately.
|
|
79
|
+
---
|
|
78
80
|
|
|
79
|
-
|
|
81
|
+
## 🎮 Gameplay Services
|
|
80
82
|
|
|
81
|
-
|
|
83
|
+
Valence can automatically inject core game systems into your project.
|
|
82
84
|
|
|
83
|
-
|
|
85
|
+
### `valence add <feature>`
|
|
84
86
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
-
|
|
87
|
+
#### Core Systems
|
|
88
|
+
* **`input`**: Unified Action Mapping (Keyboard/Gamepad) via Angular Signals.
|
|
89
|
+
* **`audio`**: Channel-based audio manager (Master/Music/SFX) using Howler.js.
|
|
90
|
+
* **`storage`**: Secure, atomic file I/O for save games (Write-Temp-Rename pattern) via Electron IPC.
|
|
91
|
+
* **`settings`**: Centralized configuration manager (Audio/Graphics) persisted to storage.
|
|
92
|
+
* **`state`**: Strict Game State Machine (Boot, Menu, Gameplay, Paused) via Signals.
|
|
88
93
|
|
|
89
|
-
|
|
94
|
+
#### 3D Features (Babylon.js)
|
|
95
|
+
* **`physics`**: Installs Havok engine (WASM) & initializes physics.
|
|
96
|
+
* **`inspector`**: Installs & binds Babylon Inspector to `Ctrl+I`.
|
|
97
|
+
* **`gui`**: Installs `lil-gui` debug panel.
|
|
98
|
+
* **`materials`**: Installs `@babylonjs/materials`.
|
|
99
|
+
* **`skybox`**: Creates environmental skybox.
|
|
100
|
+
* **`xr`**: Initializes WebXR (VR/AR) experience.
|
|
90
101
|
|
|
91
|
-
|
|
102
|
+
#### Universal Features
|
|
103
|
+
* **`tailwind`**: Configures TailwindCSS with Angular.
|
|
104
|
+
* **`multiplayer`**: Scaffolds Colyseus server & client.
|
|
105
|
+
* **`pipeline`**: Enables Asset Optimization Pipeline (sharp).
|
|
106
|
+
* **`native`**: Scaffolds Rust (Neon) native module.
|
|
92
107
|
|
|
93
|
-
|
|
94
|
-
- `inspector`: Installs `@babylonjs/inspector` and binds `Ctrl+I` to toggle the dedicated 3D debugger overlay.
|
|
95
|
-
- `gui`: Installs `lil-gui` and creates a debug panel for tweaking parameters at runtime.
|
|
96
|
-
- `materials`: Installs `@babylonjs/materials`, enabling Grid, Gradient, and other advanced materials.
|
|
97
|
-
- `skybox`: Automatically creates a large skybox mesh to provide environmental context.
|
|
98
|
-
- `xr`: Initializes WebXR default experience (Teleportation + Controller support) for VR/AR.
|
|
99
|
-
- `tailwind`: Configures TailwindCSS with Angular (PostCSS, Config, Styles).
|
|
108
|
+
---
|
|
100
109
|
|
|
101
|
-
|
|
110
|
+
## 🎲 Generators
|
|
102
111
|
|
|
103
|
-
|
|
112
|
+
### `valence generate scene <name>`
|
|
113
|
+
*Alias: `valence g scene <name>`*
|
|
114
|
+
Scaffolds a new Scene component:
|
|
115
|
+
* **3D**: Pre-wired Babylon.js `Scene` with Camera/Light/Resize handling.
|
|
116
|
+
* **2D**: Pre-wired Phaser `Scene` class with lifecycle methods.
|
|
104
117
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
118
|
+
### `valence generate bridge <name>`
|
|
119
|
+
*Alias: `valence g bridge <name>`*
|
|
120
|
+
Generates a type-safe IPC communication channel:
|
|
121
|
+
* **Main Process**: Registers `ipcMain.handle`.
|
|
122
|
+
* **Preload**: Exposes `contextBridge` API.
|
|
123
|
+
* **Service**: Creates Angular service wrapper.
|
|
110
124
|
|
|
111
125
|
### `valence codegen assets`
|
|
126
|
+
Scans `src/assets` and generates typed constants in `core/asset-keys.ts` for IntelliSense.
|
|
112
127
|
|
|
113
|
-
|
|
128
|
+
---
|
|
114
129
|
|
|
115
|
-
|
|
130
|
+
## 🩺 Diagnostics
|
|
116
131
|
|
|
117
132
|
### `valence doctor`
|
|
133
|
+
Diagnoses your development environment (Node, NPM, Git).
|
|
118
134
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
- Verifies Git installation.
|
|
122
|
-
- Checks for global Angular CLI (optional).
|
|
135
|
+
### `valence verify`
|
|
136
|
+
Performs deep health check of project structure and configuration.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"add.d.ts","sourceRoot":"","sources":["../../src/commands/add.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"add.d.ts","sourceRoot":"","sources":["../../src/commands/add.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,UAAU,GAAU,SAAS,MAAM,kBAmD/C,CAAA"}
|