elpy

v1.1.16

Published

8 days ago

2D JavaScript game engine.

Downloads

227

0High
0Medium
0Low

space2pacman

html5 game rendering engine 2d canvas web javascript

Elpy.js - 2D JavaScript game engine.

logo

| Demo | Game examples | | :---: | :---: |

Docs

Install
Basic usage example
Engine
- create()
- add()
- key()
- keydown()
- keyup()
- mousemove()
- click()
- tick()
- nextTick()
- checkObjectInViewport()
- fixingCamera()
- unfixingCamera()
- destroy()
- on()
  - Event 'load'
  - Event 'animation'
- load()
Engine getters
Object
- run()
- move()
- fly()
- jump()
- fall()
- push()
- rotate()
- stop()
- destroy()
- collision()
- on()
  - Event 'collision'
  - Event 'move'
  - Event 'rotate'
  - Event 'destroy'
  - Event 'state'
  - Event 'jump'
  - Event 'fall'
  - Event 'fly'
  - Event object
- removeCollision()
Object getters
Object setters
Development
License

games

Install

Download

Latest builds are available in the project releases page.

CDN

https://unpkg.com/elpy/dist/elpy.min.js

NPM

npm install elpy

Basic usage example

<!DOCTYPE html>
<html>
<head>
  <title>Elpy.js</title>
</head>
<body>
  <canvas id="field"></canvas>
  <script src="elpy.min.js"></script>
  <script>
    const elpy = new Elpy('#field', 500, 500);
    const player = elpy.create('player', 50, 50, 20, 20);
    const wall = elpy.create('wall', 100, 50, 20, 20, { color: 'brown' });

    elpy.add(player);
    elpy.add(wall);
    player.collision(wall);

    elpy.key(key => {
      if (key === 'ArrowUp') {
        player.move(player.x, player.y - 1);
      }
      if (key === 'ArrowDown') {
        player.move(player.x, player.y + 1);
      }
      if (key === 'ArrowLeft') {
        player.move(player.x - 1, player.y);
      }
      if (key === 'ArrowRight') {
        player.move(player.x + 1, player.y);
      }
    });
  </script>
</body>
</html>

Engine

Create engine instance

const elpy = new Elpy(
  "#element", // id element canvas or HTML object element get by document.querySelector().
  500, // width.
  500, // height.
  // options.
  {
    preload, // default - true, enable / disable preloader.
    favicon // default - true, enable / disable favicon.
  }
)

create(name, x, y, width, height, options)

Creates and returns an engine object.

min example

const player = elpy.create('player', 10, 10, 20, 20);

max example

const player = elpy.create('player', 10, 10, 20, 20, {
  obstacle: true, // default - true.
  pushing: false, // default - false.
  disabledEvents: false, // default - false.
  type: 'player object', // default - null.
  custom: {}, // default - null.
  color, // default - 'black'.
  // image: '' or image: { path: '', repeat: false }.
  image: { 
    path: '', // default - null.
    repeat: false // default - false.
  },
  // default - null.
  images: [
    {
      paths: ['images/player_left.png', 'images/player_right.png'], // path to image.
      state: 'move:left', // in what condition are the images available. player.state = 'move:left'.
      time: 100 // if player.animate = true - switching time between images.
    }
  ]
});

| name | type | description | | :---: | :---: | :--- | | `obstacle` | `<Boolean>` | To determine if an object is an obstacle if there is a collision with the object. If the object was not added to the collision then the object will pass through another object. If an object has been added to a collision, then by default the object will stop on collision. If it is necessary that the collision event occur and the object passes through the object, then the obstacle property can be switched to false. | | `pushing` | `<Boolean>` | Will the object move if it is pushed through the push method. | | `disabledEvents` | `<Boolean>` | Disables all events for an object. | | `type` | `<Null>`, `<String>` | A simple string that allows you to add your own data. It is convenient to use to set the type of an object in order to distinguish them from each other later. | | `custom` | `<Null>`, `<Object>` | An object where you can add your fields and use them via `object.options.custorm`. | | `color` | `<String>` | Set object color. | | `image` | `<String>`, `<Object>` | Set image. Two data types can be used: String or Object. `image: 'path/to/image/'` or for repeat image `image: { path: 'path/to/image/', repeat: true }`. | | `images` | `<Array>` | Can be used if the object has several images that can be changed through the state. For example, the image of the position when the player goes to the right or left. You can also make animation of switching frames through the animate property (Object getters). The switching `time` is set in the time property. |

add(object)

Add an object to the engine.

elpy.add(player);

key(callback)

Listen for keydown and keyup events. Сallback is always called when a key is pressed.

elpy.key(key => {
  if (key === 'ArrowUp') {
    // ...
  }
});

keydown(callback)

Сallback fires once on click.

elpy.keydown(key => {
  if (key === 'ArrowUp') {
    // ...
  }
});

keyup(callback)

Сallback fires once on click.

elpy.keyup(key => {
  if (key === 'ArrowUp') {
    // ...
  }
});

mousemove(callback)

Handles mouse movement on the canvas.

elpy.mousemove((x, y) => {
  // x, y - coordinates inside the canvas.
});

click(callback)

Handles mouse click on the canvas.

elpy.click((x, y) => {
  // x, y - coordinates inside the canvas.
});

tick(callback)

Called recursively. The next call is queued after the scene is updated (render). To cancel the call inside the callback, return false.

let delta = 0;
// tick will be called 100 times.
elpy.tick(() => {
  if (delta === 100) {
    return false; // stop tick.
  }

  delta++;
  
  player.move(player.x + delta, player.y + delta);
});

nextTick(callback)

Adds a callback to the queue after the scene is updated (rendered) and calls callback once.

elpy.nextTick(() => {
  // ...
});

checkObjectInViewport(object)

Checking if the object is in the visible area.

elpy.checkObjectInViewport(player); // returns true or false.

fixingCamera(object, fixedCamera)

Fix the camera behind the object. You can fix both in one coordinate and in two.

min example

elpy.fixingCamera(player, {
  x: true
});

max example

elpy.fixingCamera(player, {
  x: true,
  y: true
});

unfixingCamera()

Unfix the camera from the one previously fixed behind the object.

elpy.unfixingCamera();

destroy()

Destroying all objects and stopping rendering.

elpy.destroy();

on(event, callback)

Listen to the engine event.

elpy.on('eventName', () => {
  // event handling.
});

Event: `'load'`

Called when the application has loaded all resources and is ready.

elpy.on('load', () => {
  // event handling.
});

Event: `'animation'`

Called when an object images are switched.

elpy.on('animation', (object, image, images) => {
  // object - object to be animated.
  // image - current image. Examlpe: 'images/player_left.png'.
  // images - a list of all images that were passed to paths when the object was created. Example: ['images/player_left.png', 'images/player_right.png'].
});

load()

The method is called automatically when document.readyState === 'complete'. If the engine has not loaded and is in a black window state, you can call load manually after all operations with the engine (creating objects, adding objects, etc.).

elpy.load();

Engine getters

elpy.width;

Object

run(step)

| name | type | default | | :---: | :---: | :---: | | step | <Number> | 1 |

Vector movement. Moves in different directions depending on positive or negative values.

min example

player.run();

max example

player.run(-1);

move(x, y)

| name | type | | :---: | :---: | | x | <Number> | | y | <Number> |

Move at coordinates.

player.move(10, 10);

fly(degrees, distance, step)

Vector flight.

min example

player.fly(0);

max example

player.fly(0, 100, 10);

jump(height, multiplier, forced)

Object jumps with further fall.

min example

player.jump(10);

max example

player.jump(10, 0.5, true);

fall(multiplier)

| name | type | default | | :---: | :---: | :---: | | multiplier | <Number> | 0.1 |

Free fall.

min example

player.fall();

max example

player.fall(0.5);

push(object)

Pushing an object. The one who pushes must have a collision with what he pushes.

player.push(object);

rotate(degrees, x, y)

| name | type | default | | :---: | :---: | :---: | | degrees | <Number> | 0 | | x | <Number> | 0 | | y | <Number> | 0 |

Object rotation.

min example

player.rotate(90);

max example

player.rotote(90, 10, 20);

stop()

Stop actions: jump, fall, fly.

player.stop();

destroy()

Destroy object.

player.destroy();

collision(object)

Add collision object.

player.collision(object);

on(event, callback)

Listen to the object event.

player.on('eventName', () => {
  // event handling.
});

Event: `'collision'`

Called in the collision of the object.

player.on('collision', (object, side) => {
  // object - collision object.
  // side - side of the object that was collided.
});

Event: `'move'`

Called when moving the object.

player.on('move', () => {
  // event handling.
});

Event: `'rotate'`

Called when rotating the object.

player.on('rotate', () => {
  // event handling.
});

Event: `'destroy'`

Called when the object is destroyed.

player.on('destroy', () => {
  // event handling.
});

Event: `'state'`

Called when changing the condition of the object.

player.on('state', () => {
  // event handling.
});

Event: `'jump'`

Called when jumping an object.

player.on('jump', event => {
  // event - event object.
});

Event: `'fall'`

Called when the object falls.

player.on('fall', event => {
  // event - event object.
});

Event: `'fly'`

Called when the object flies.

player.on('fly', event => {
  // event - event object.
});

Event object

The object that is returned in the event callback: jump, fall, fly.

player.on('jump', event => {
  event.stopped; // returns true or false.
  event.paused; // returns true or false.
  event.stop();
  event.pause();
  event.resume();
});

removeCollision(object)

Remove collision object from collision list.

player.removeCollision(object);

Object getters

player.name;

Object setters

player.width = 10;

Development

npm run serve

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Elpy.js - 2D JavaScript game engine.

Docs

Install

Download

CDN

NPM

Basic usage example

Engine

Create engine instance

create(name, x, y, width, height, options)

add(object)

key(callback)

keydown(callback)

keyup(callback)

mousemove(callback)

click(callback)

tick(callback)

nextTick(callback)

checkObjectInViewport(object)

fixingCamera(object, fixedCamera)

unfixingCamera()

destroy()

on(event, callback)

Event: 'load'

Event: 'animation'

load()

Engine getters

Object

run(step)

move(x, y)

fly(degrees, distance, step)

jump(height, multiplier, forced)

fall(multiplier)

push(object)

rotate(degrees, x, y)

stop()

destroy()

collision(object)

on(event, callback)

Event: 'collision'

Event: 'move'

Event: 'rotate'

Event: 'destroy'

Event: 'state'

Event: 'jump'

Event: 'fall'

Event: 'fly'

Event object

removeCollision(object)

Object getters

Object setters

Development

License

Event: `'load'`

Event: `'animation'`

Event: `'collision'`

Event: `'move'`

Event: `'rotate'`

Event: `'destroy'`

Event: `'state'`

Event: `'jump'`

Event: `'fall'`

Event: `'fly'`