colinespinas / alge

🎮 A simple 2D game engine written in Typescript

alge

Scene -> Entity -> Component based game engine written in Typescript.

Created and used for personal purpose only, use at your own risk.

There is no documentation available at the moment.

Usage

Basic player controlled entity example:

File structure:

.
+-- index.ts
+-- entities
|   +-- Player.ts
+-- components
    +-- PlayerController.ts

Create a PlayerController component to manage inputs from the player:

// components/PlayerController.ts
import { Component, InputManager, Key, Cursor, TimeManager } from "alge";

export default class PlayerController extends Component {
	
	protected input : InputManager = this.parent.engine.getManager("Input");
	protected time : TimeManager = this.parent.engine.getManager("Time");;
	public speed : number = 10;

	public init() {
		this.input.SetCursor(Cursor.Hidden);
	}
	
	public update() {

		if (this.input.getKeyDown(Key.UpArrow)) {
			this.parent.transform.position.y -= this.speed * this.time.deltaTime * 100;
		}
		if (this.input.getKeyDown(Key.DownArrow)) {
			this.parent.transform.position.y += this.speed * this.time.deltaTime * 100;
		}
		if (this.input.getKeyDown(Key.LeftArrow)) {
			this.parent.transform.position.x -= this.speed * this.time.deltaTime * 100;
		}
		if (this.input.getKeyDown(Key.RightArrow)) {
			this.parent.transform.position.x += this.speed * this.time.deltaTime * 100;
		}
	}
}

Create a Player entity and add a Sprite component to display a sprite and the PlayerController component previously created:

// entities/Player.ts
import { Entity, Sprite, Engine} from "alge";
import PlayerController from "../components/PlayerController";

export default class Player extends Entity {

	protected sprite : Sprite;
	protected controller : PlayerController;

	public create() {
		this.sprite = new Sprite(this, "Sprite", { 
			src: this.properties["sprite"],
		});
		this.addComponent(this.sprite);

		this.controller = new PlayerController(this, "Controller");
		this.addComponent(this.controller);
	}
}

Instanciate the alge's Engine class and create a PIXIScene using the PIXISceneManager. Then add a Camera and your Player entity to the scene and run the engine:

// index.ts
import { Engine, PIXIScene } from 'alge';
import Player from "./entities/Player";

const game = new Engine({fullscreen: true});

let mainScene : PIXIScene = game.getManager("Scene").createScene("MainScene");

let camera = new Camera("MainCamera");
mainScene.addEntity(camera);

let player = new Player("Player", { sprite:"path/to/sprite" });
mainScene.addEntity(player);

game.run();

License

alge is distributed under the MIT License. See LICENSE for more information.

Contact

Colin Espinas - Website - [email protected]

Project link: https://github.com/ColinEspinas/alge

alge's Issues

Build dists for using modules instead of building from sources in every projects

A user needs to be able to use the engine without building from sources, just by using a module or a CDN.