action-engine-js 1.0.0 → 1.0.2

package/LICENSE

@@ -1,45 +1,52 @@
-MIT License
-
-Copyright (c) 2025 Tomobobo710
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
----
-
-This project includes GoblinPhysics, licensed under the Zlib License:
-
-Copyright (c) 2012 Chandler Prall
-
-This software is provided 'as-is', without any express or implied
-warranty. In no event will the authors be held liable for any damages
-arising from the use of this software.
-
-Permission is granted to anyone to use this software for any purpose,
-including commercial applications, and to alter it and redistribute it
-freely, subject to the following restrictions:
-
-1. The origin of this software must not be misrepresented; you must not
-   claim that you wrote the original software. If you use this software
-   in a product, an acknowledgment in the product documentation would be
-   appreciated but is not required.
-2. Altered source versions must be plainly marked as such, and must not be
-   misrepresented as being the original software.
-3. This notice may not be removed or altered from any source distribution.
-
-Repository: https://github.com/chandlerprall/GoblinPhysics
+MIT License
+
+Copyright (c) 2025 Tomobobo710
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+This project includes GoblinPhysics, licensed under the Zlib License:
+
+Copyright (c) 2012 Chandler Prall
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.
+
+Repository: https://github.com/chandlerprall/GoblinPhysics
+
+---
+
+This project includes TimGM6mb soundfont
+Source: https://www.timbrechbill.com/saxguru/Timidity.php
+Author: Tim Brechbill
+Status: Free to use

package/README.md

@@ -19,6 +19,72 @@ Action Engine simplifies game creation by handling all the tedious infrastructur
 
 ## Quick Start
 
+### Installation
+
+**Option 1: CDN (instant, no build step)**
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>My Game</title>
+  <style>
+    html, body {
+      margin: 0;
+      padding: 0;
+      background: #0a0a2a;
+      width: 100%;
+      height: 100%;
+      overflow: hidden;
+    }
+  </style>
+</head>
+<body>
+  <div id="appContainer">
+    <div id="UIControlsContainer"></div>
+  </div>
+  
+  <script src="https://unpkg.com/action-engine-js@latest/dist/action-engine.min.js"></script>
+  <script src="game.js"></script>
+</body>
+</html>
+```
+
+**Option 2: npm (for bundlers)**
+```bash
+npm install action-engine-js
+```
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>My Game</title>
+  <style>
+    html, body {
+      margin: 0;
+      padding: 0;
+      background: #0a0a2a;
+      width: 100%;
+      height: 100%;
+      overflow: hidden;
+    }
+  </style>
+</head>
+<body>
+  <div id="appContainer">
+    <div id="UIControlsContainer"></div>
+  </div>
+  
+  <script src="node_modules/action-engine-js/dist/action-engine.min.js"></script>
+  <script src="game.js"></script>
+</body>
+</html>
+```
+
 ### Create a Game Class
 
 ```javascript
@@ -295,7 +361,7 @@ action_update(deltaTime) {
     // Move up
   }
   
-  if (this.input.isKeyPressed("Action1")) {
+  if (this.input.isKeyJustPressed("Action1")) {
     this.player.jump();
   }
 }
@@ -343,6 +409,17 @@ this.audio.playSound("kick", {
 - ✅ Math utilities (vectors, matrices)
 - ✅ Debug visualization tools
 
+## Development
+
+To build the minified bundle locally:
+
+```bash
+npm install
+npm run build
+```
+
+This generates `dist/action-engine.min.js` from all source files in dependency order.
+
 ---
 
-**Ready to build?** Start with `game.js` as your template, reference `demo.js` for examples, and check the demo app running in your browser!
+**Ready to build?** Start with the HTML template above, create your `game.js`, and you're good to go!