angry-pixel 1.2.1 → 1.2.3

package/.github/workflows/analyzeCode.yml

@@ -0,0 +1,25 @@
+name: Reusable Workflow Analyze Code
+
+on:
+    workflow_call:
+
+jobs:
+    analyze:
+        name: "[Analyze Code]"
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+
+            - name: "[Restore node modules]"
+              id: cache-node-modules
+              uses: actions/cache@v2
+              with:
+                  path: node_modules
+                  key: ${{ runner.os }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-nodemodules-
+            - name: "[Run lint]"
+              run: yarn run lint
+
+            - name: "[Run prettier-check]"
+              run: yarn run prettier-check

package/.github/workflows/buildCode.yml

@@ -0,0 +1,23 @@
+name: Reusable Workflow Build Code
+
+on:
+    workflow_call:
+
+jobs:
+    build:
+        name: "[Build Core]"
+        runs-on: ubuntu-latest
+        if: contains('refs/heads/main', github.ref)
+        steps:
+            - uses: actions/checkout@v2
+
+            - name: "[Restore node modules]"
+              id: cache-node-modules
+              uses: actions/cache@v2
+              with:
+                  path: node_modules
+                  key: ${{ runner.os }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-nodemodules-
+            - name: "[Run build]"
+              run: yarn run build

package/.github/workflows/main.yml

@@ -1,13 +1,15 @@
-name: CI
-on: push
-jobs:
-    build:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/setup-node@v1
-              with:
-                  node-version: 12.x
-            - uses: actions/checkout@v2
-            - run: npm install
-            - run: npm run lint
-            - run: npm run prettier-check
+name: Continuous Integration App
+
+on: push
+
+jobs:
+    Setup:
+        uses: ./.github/workflows/setupNode.yml
+
+    Analyze:
+        needs: Setup
+        uses: ./.github/workflows/analyzeCode.yml
+
+    Build:
+        needs: [Setup, Analyze]
+        uses: ./.github/workflows/buildCode.yml

package/.github/workflows/setupNode.yml

@@ -0,0 +1,40 @@
+name: Reusable Workflow Node Setup
+
+on:
+    workflow_call:
+
+jobs:
+    setup:
+        name: "[Setup]"
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - name: "[Use node 16.x]"
+              uses: actions/setup-node@v2
+              with:
+                  node-version: 16.x
+                  cache: "yarn"
+
+            - name: "[Get yarn cache directory path]"
+              id: yarn-cache-dir-path
+              run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
+
+            - name: "[Cache yarn directory]"
+              id: cache-yarn-cache
+              uses: actions/cache@v2
+              with:
+                  path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+                  key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-yarn-
+            - name: "[Cache node modules]"
+              id: cache-node-modules
+              uses: actions/cache@v2
+              with:
+                  path: node_modules
+                  key: ${{ runner.os }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-nodemodules-
+            - name: "[Install dependencies]"
+              if: steps.cache-yarn-cache.outputs.cache-hit != 'true' || steps.cache-node-modules.outputs.cache-hit != 'true'
+              run: yarn install

package/README.md

@@ -1,3 +1,168 @@
-# Angry Pixel Engine
+# Introduction
 
-A lightweight 2D game engine made with TypeScript
+## What is Angry Pixel?
+
+Angry Pixel is a 2D engine for browsers games written in Typescript.
+
+Main features:
+
+-   Sprites and animations
+-   Tilemaps (csv and Tiled)
+-   WebGL rendering
+-   Polygonal collisions and static physics resolution
+-   Input (keyboard, mouse, gamepad, touch)
+-   Scene-Object-Component based architecture
+
+## Getting Started
+
+### Installation
+
+```bash
+npm i angry-pixel
+```
+
+### Initialize
+
+Create and configure a new Game instance.
+
+```typescript
+import { Game, GameConfig } from "angry-pixel";
+
+const config: GameConfig = {
+    containerNode: document.getElementById("app"),
+    gameWidth: 1920,
+    gameHeight: 1080,
+    canvasColor: "#00D9D9",
+};
+
+// create the game
+const game = new Game(config);
+```
+
+### Create a Scene
+
+Crear la clase MainScene que extiende Scene and load an image that will be used as a Sprite.
+
+```typescript
+import { Scene } from "angry-pixel";
+
+class MainScene extends Scene {
+    protected init(): void {
+        this.assetManager.loadImage("logo.png");
+    }
+}
+```
+
+Add the scene to the game.
+
+```typescript
+const config: GameConfig = {
+    containerNode: document.getElementById("app"),
+    gameWidth: 1920,
+    gameHeight: 1080,
+    canvasColor: "#00D9D9",
+};
+
+// create the game
+const game = new Game(config);
+// add scene
+game.addScene(MainScene, "MainScene");
+```
+
+### Create a Game Object
+
+Create the Logo class extending GameObject and add the image using the native SpriteRenderer component.
+
+```typescript
+import { GameObject, Sprite, SpriteRenderer } from "angry-pixel";
+
+class Logo extends GameObject {
+    protected init(): void {
+        this.addComponent(SpriteRenderer, {
+            sprite: new Sprite({
+                image: this.assetManager.getImage("logo.png"),
+            }),
+        });
+    }
+}
+```
+
+Add the object to the scene.
+
+```typescript
+class MainScene extends Scene {
+    protected init(): void {
+        this.assetManager.loadImage("logo.png");
+        this.addGameObject(Logo);
+    }
+}
+```
+
+### Create a Component
+
+Create the MoveAndBounce class that extends Component and contains the logic for object movement, using the native Transform component (natively included in the GameObject), vectors and delta time.
+
+```typescript
+import { Component, Transform, Vector2 } from "angry-pixel";
+
+class MoveAndBounce extends Component {
+    private transform: Transform;
+    private direction: Vector2;
+    private speed: number;
+
+    protected init(): void {
+        this.transform = this.gameObject.transform;
+        this.direction = new Vector2(1, 1);
+        this.speed = 200; // pixels per second
+    }
+
+    // this method is called once per frame
+    protected update(): void {
+        if (this.transform.position.y >= 476 || this.transform.position.y <= -476) {
+            this.direction.y *= -1;
+        }
+        if (this.transform.position.x >= 896 || this.transform.position.x <= -896) {
+            this.direction.x *= -1;
+        }
+
+        this.transform.position.x += this.direction.x * this.speed * this.timeManager.deltaTime;
+        this.transform.position.y += this.direction.y * this.speed * this.timeManager.deltaTime;
+    }
+}
+```
+
+Add the component to the object.
+
+```typescript
+class Logo extends GameObject {
+    protected init(): void {
+        this.addComponent(SpriteRenderer, {
+            sprite: new Sprite({
+                image: this.assetManager.getImage("logo.png"),
+            }),
+        });
+
+        this.addComponent(MoveAndBounce);
+    }
+}
+```
+
+### Run the game
+
+```typescript
+const config: GameConfig = {
+    containerNode: document.getElementById("app"),
+    gameWidth: 1920,
+    gameHeight: 1080,
+    canvasColor: "#00D9D9",
+};
+
+// create the game
+const game = new Game(config);
+// add scene
+game.addScene(MainScene, "MainScene");
+// run the game
+game.run();
+```
+
+#### Check this example live [here](https://angrypixel.gg/angry-pixel-logo-bounce)

package/lib/core/Component.d.ts

@@ -5,7 +5,6 @@ import { GameActor } from "./GameActor";
 import { Container } from "../utils/Container";
 export type ComponentClass<T extends Component = Component> = new (container: Container, gameObject: GameObject, name?: string) => T;
 export declare abstract class Component extends GameActor {
-    readonly id: string;
     readonly name: string;
     readonly gameObject: GameObject;
     readonly allowMultiple: boolean;

package/lib/core/GameObject.d.ts

@@ -5,9 +5,9 @@ import { Scene } from "./Scene";
 import { GameActor, InitOptions } from "./GameActor";
 import { Container } from "../utils/Container";
 export declare const LAYER_DEFAULT = "Default";
-export type GameObjectClass<T extends GameObject = GameObject> = new (container: Container, name?: string, parent?: GameObject) => T;
+export type GameObjectClass<T extends GameObject = GameObject> = new (container: Container, id: number, name?: string, parent?: GameObject) => T;
 export declare class GameObject extends GameActor {
-    readonly id: string;
+    readonly id: number;
     readonly name: string;
     tag: string;
     layer: string;
@@ -18,7 +18,7 @@ export declare class GameObject extends GameActor {
     private components;
     private activeComponentsCache;
     private activeChildrenCache;
-    constructor(container: Container, name?: string, parent?: GameObject);
+    constructor(container: Container, id: number, name?: string, parent?: GameObject);
     get active(): boolean;
     set active(active: boolean);
     get parent(): GameObject | null;

package/lib/core/managers/GameObjectManager.d.ts

@@ -4,7 +4,7 @@ import { Container } from "../../utils/Container";
 export interface IGameObjectManager {
     addGameObject<T extends GameObject>(gameObjectClass: GameObjectClass<T>, options?: InitOptions, parent?: GameObject, name?: string): T;
     findGameObjects<T extends GameObject>(gameObjectClass?: GameObjectClass<T>): T[];
-    findGameObjectById<T extends GameObject>(id: string): T;
+    findGameObjectById<T extends GameObject>(id: number): T;
     findGameObject<T extends GameObject>(gameObjectClass: GameObjectClass<T>): T;
     findGameObject<T extends GameObject>(name: string): T;
     findGameObject<T extends GameObject>(filter: GameObjectClass<T> | string): T;
@@ -22,7 +22,7 @@ export declare class GameObjectManager implements IGameObjectManager {
     constructor(container: Container);
     addGameObject<T extends GameObject>(gameObjectClass: GameObjectClass<T>, options?: InitOptions, parent?: GameObject, name?: string): T;
     findGameObjects<T extends GameObject>(gameObjectClass?: GameObjectClass<T>): T[];
-    findGameObjectById<T extends GameObject>(id: string): T;
+    findGameObjectById<T extends GameObject>(id: number): T;
     findGameObject<T extends GameObject>(gameObjectClass: GameObjectClass<T>): T;
     findGameObject<T extends GameObject>(name: string): T;
     findGameObjectsByParent<T extends GameObject>(parent: GameObject): T[];