azengine
v0.1.6
Published
A 2d web game engine
Maintainers
nsl-developReadme
AZEngine | Web & Electron Game Engine
Setup
To install the module :
npm i azengineInsert your script in the Electron index.html :
<!DOCTYPE html>
<html>
<head>
<title>AZEngine</title>
</head>
<body>
<script type="text/javascript" src="myScript.js"></script>
</body>
</html>To use AZEngine in your script :
const AZEngine = require("azengine")Using objects
We will first create an image object in position (0,0), and of square size 250x250.
To create a new object :
var myObject = AZEngine.createObject("image.png", {x: 0, y: 0}, {width: 250, height: 250}, 0)To get the object ID :
myObject.getId()To remove the object :
AZEngine.removeObject(myObject.getId())Using transforms
We will see how to define the position, size, and rotation of an object.
To set the position :
myObject.setPosition({x: 100, y: 100})To get the position :
myObject.getPosition().x
//return position x
myObject.getPosition().y
//return position yTo set the size :
myObject.setSize({width: 500, height: 500})To get the size :
myObject.getSize().width
//return width
myObject.getSize().height
//return heightTo set the rotation :
myObject.setRotation(45)To get the rotation :
myObject.getRotation()
//return rotationUsing animations
Now, let's animate the created object.
To create an animation :
myObject.createAnimation("myAnimation", {frames_delay: 10, loop: true}, ["image1.png","image2.png","image3.png"])To start the created animation :
myObject.startAnimation("myAnimation")To stop the current animation :
myObject.stopAnimation()To get the current animation :
myObject.getAnimation()
//return current animation nameUsing interfaces
Let's see how to create a simple menu.
To create a new interface :
var myInterface = AZEngine.createInterface()To get the interface ID :
myInterface.getId()To remove the interface :
AZEngine.removeInterface(myInterface.getId())To create a new element in the interface :
var myInterfaceElement = myInterface.createElement('button', {x: 0, y: 0}, {width: 250, height: 40}, {text: "Hello", color: "#000000", background_color: "#ffffff", font_size: 30})To get the element ID :
myInterfaceElement.getId()To remove the element :
myInterfaceElement.removeElement(myInterfaceElement.getId())Using audios
Now let's see how to manipulate the audio channels
To create a new audio channel :
var myAudio = AZEngine.createAudio("myChannel")To play a file on the channel :
myAudio.play("music.mp3")To stop the audio of a channel :
myAudio.stop();To pause the audio of a channel :
myAudio.pause();