action-engine-js 1.0.0 → 1.0.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/LICENSE CHANGED
@@ -43,3 +43,10 @@ freely, subject to the following restrictions:
43
43
  3. This notice may not be removed or altered from any source distribution.
44
44
 
45
45
  Repository: https://github.com/chandlerprall/GoblinPhysics
46
+
47
+ ---
48
+
49
+ This project includes TimGM6mb soundfont
50
+ Source: https://www.timbrechbill.com/saxguru/Timidity.php
51
+ Author: Tim Brechbill
52
+ Status: Free to use
package/README.md CHANGED
@@ -19,6 +19,70 @@ Action Engine simplifies game creation by handling all the tedious infrastructur
19
19
 
20
20
  ## Quick Start
21
21
 
22
+ ### Installation
23
+
24
+ **Option 1: CDN (instant, no build step)**
25
+ ```html
26
+ <!DOCTYPE html>
27
+ <html>
28
+ <head>
29
+ <meta charset="UTF-8" />
30
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
31
+ <title>My Game</title>
32
+ <style>
33
+ html, body {
34
+ margin: 0;
35
+ padding: 0;
36
+ width: 100%;
37
+ height: 100%;
38
+ overflow: hidden;
39
+ }
40
+ </style>
41
+ </head>
42
+ <body>
43
+ <div id="appContainer">
44
+ <div id="UIControlsContainer"></div>
45
+ </div>
46
+
47
+ <script src="https://unpkg.com/action-engine-js@latest/dist/action-engine.min.js"></script>
48
+ <script src="game.js"></script>
49
+ </body>
50
+ </html>
51
+ ```
52
+
53
+ **Option 2: npm (for bundlers)**
54
+ ```bash
55
+ npm install action-engine-js
56
+ ```
57
+
58
+ ```html
59
+ <!DOCTYPE html>
60
+ <html>
61
+ <head>
62
+ <meta charset="UTF-8" />
63
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
64
+ <title>My Game</title>
65
+ <style>
66
+ html, body {
67
+ margin: 0;
68
+ padding: 0;
69
+ width: 100%;
70
+ height: 100%;
71
+ overflow: hidden;
72
+ }
73
+ </style>
74
+ </head>
75
+ <body>
76
+ <div id="appContainer">
77
+ <div id="UIControlsContainer"></div>
78
+ </div>
79
+
80
+ <script src="node_modules/action-engine-js/dist/action-engine.min.js"></script>
81
+ <script src="game.js"></script>
82
+ </body>
83
+ </html>
84
+ ```
85
+
22
86
  ### Create a Game Class
23
87
 
24
88
  ```javascript
@@ -343,6 +407,17 @@ this.audio.playSound("kick", {
343
407
  - ✅ Math utilities (vectors, matrices)
344
408
  - ✅ Debug visualization tools
345
409
 
410
+ ## Development
411
+
412
+ To build the minified bundle locally:
413
+
414
+ ```bash
415
+ npm install
416
+ npm run build
417
+ ```
418
+
419
+ This generates `dist/action-engine.min.js` from all source files in dependency order.
420
+
346
421
  ---
347
422
 
348
- **Ready to build?** Start with `game.js` as your template, reference `demo.js` for examples, and check the demo app running in your browser!
423
+ **Ready to build?** Start with the HTML template above, create your `game.js`, and you're good to go!