kippy 0.2.0 → 0.2.1

package/README.md

@@ -31,6 +31,9 @@ const game = new Game({
 
 // Start the game loop
 game.start();
+
+// You can also swap canvas if you want
+// game.setCanvas(someOtherCanvas);
 ```
 
 ### Create a scene
@@ -63,7 +66,8 @@ const entity = new Entity({
     sprite, // Entity's sprite to be rendered, type Sprite
     x, // Entity's x position (centered), type number
     y, // Entity's y position (centered), type number
-    rotation // Entity's rotation in radians, type number
+    rotation, // Entity's rotation in radians, type number
+    body, // Entity's physical body, type EntityBody
 });
 
 // Add it to a scene
@@ -84,13 +88,13 @@ A sprite represents what an entity looks like, the "graphics part", you can crea
 import { Sprite } from "kippy";
 
 const sprite = new Sprite({
-    texture, // Sprite's texture, can be HTMLImageElement, HTMLCanvasElement, OffscreenCanvas, ImageBitmap
+    texture, // Sprite's texture - HTMLImageElement, HTMLCanvasElement, OffscreenCanvas, ImageBitmap
     width, // Sprite's width, type number
     height // Sprite's height, type number
 });
 
 // Set sprite for an entity
-entity.setSprite(sprite);
+entity.sprite = sprite;
 ```
 
 ### Add controls
@@ -116,11 +120,39 @@ input.mouseY; // Current Y position of mouse
 
 ### Physics
 
+For movements, currently you can create a `RigidBody`:
+```js
+// Create a rigid body
+const rigidBody = new RigidBody({
+    velocityX, // X velocity, type number
+    velocityY, // Y velocity, type number
+    rotationVelocity, // Angular/rotation velocity, type number
+    mass, // Entity's mass, type number
+    inertia, // Entity's inertia, type number
+    forceX, // Entity's force on X axis, type number
+    forceY, // Entity's force on Y axis, type number
+    torque, // Entity's torque/rotational force, type number
+});
+
+// Attach body to an entity
+entity.body = rigidBody;
+
+// And you can mutate these props to update movement every frame
+entity.body.velocityX; // Set with the matching parameter above, default is 0
+entity.body.velocityY; // Set with the matching parameter above, default is 0
+entity.body.rotationVelocity; // Set with the matching parameter above, default is 0
+entity.body.mass; // Set with the matching parameter above, default is 1
+entity.body.inertia; // Set with the matching parameter above, default is 1
+entity.body.forceX; // Set with the matching parameter above, default is 0
+entity.body.forceY; // Set with the matching parameter above, default is 0
+entity.body.torque; // Set with the matching parameter above, default is 0
+```
 
+Collisions to be added.
 
 ### Animation
 
-To be added, for now call `setSprite` to swap sprites for animations.
+To be added, for now mutate `entity.sprite` to swap sprites and create animations manually.
 
 ### Audio
 

package/dist/entity.d.ts

@@ -1,19 +1,18 @@
-import { RigidBody } from "./physics.js";
+import { EntityBody } from "./physics.js";
 import { Sprite } from "./sprite.js";
 export interface EntityOptions {
     sprite?: Sprite;
     x?: number;
     y?: number;
     rotation?: number;
-    body?: RigidBody;
+    body?: EntityBody;
 }
 export declare class Entity {
     sprite?: Sprite;
     x: number;
     y: number;
     rotation: number;
-    body?: RigidBody;
+    body?: EntityBody;
     constructor(options?: EntityOptions);
-    setSprite(sprite: Sprite): void;
     render(ctx: CanvasRenderingContext2D): void;
 }

package/dist/entity.js

@@ -11,9 +11,6 @@ export class Entity {
         this.rotation = options.rotation ?? 0;
         this.body = options.body;
     }
-    setSprite(sprite) {
-        this.sprite = sprite;
-    }
     render(ctx) {
         if (this.sprite) {
             ctx.save();

package/dist/game.d.ts

@@ -14,8 +14,8 @@ export declare class Game {
     input: Input;
     physics: Physics;
     constructor(options: GameOptions);
+    setCanvas(canvas: HTMLCanvasElement): void;
     setScene(scene: Scene): void;
-    setInput(input: Input): void;
     start(): void;
     loop(timestamp: number): void;
 }

package/dist/game.js

@@ -13,14 +13,15 @@ export class Game {
         this.input = options.input ?? new Input({ canvas: this.canvas });
         this.physics = options.physics ?? new Physics();
     }
+    setCanvas(canvas) {
+        this.canvas = canvas;
+        this.ctx = this.canvas.getContext("2d");
+    }
     setScene(scene) {
         this.scene?.exit();
         this.scene = scene;
         this.scene.init();
     }
-    setInput(input) {
-        this.input = input;
-    }
     start() {
         requestAnimationFrame(this.loop.bind(this));
     }

package/dist/physics.d.ts

@@ -20,6 +20,7 @@ export declare class RigidBody {
     torque: number;
     constructor(options?: RigidBodyOptions);
 }
+export type EntityBody = RigidBody;
 export declare class Physics {
     update(entities: Entity[]): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kippy",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Kippy 2D web game engine for JS",
   "keywords": [
     "kippy",