Package Exports

@moderrkowo/jsgl
@moderrkowo/jsgl/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@moderrkowo/jsgl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

⚡ JSGL

About The Project

Client-side JavaScript library for creating web 2D games. Focusing at objective game. Use the JSGL to create 2D games.

Features

Creating 2D Games in HTML Canvas
Auto canvas scaling to size
Game Settings (autoCanvasResize...)
Creating OOP game objects
Easy events system
Resources loading system
Easy management objects with Transform and Vector2
No need to write HTML. The JSGL.ExampleHTML/JSGL.DefaultGame can render default game page.

Required

Getting Started

Browser

To include JSGL in browser add script tag to body element. Like below or check examples.

...
<body>
  <script src="https://unpkg.com/@moderrkowo/jsgl/dist/JSGL.js"></script> <!-- CDN -->
  <script src="./js/game.js"></script> 
</body>
...

Node

To include JSGL in Node, first install with npm.

npm i @moderrkowo/jsgl

Example node code

const { Vector2 } = require('@moderrkowo/jsgl');
const exampleVector2 = new Vector2(5, 10);
console.log(exampleVector2);
// Vector2 { x: 5, y: 10 }

Documentation

Developers

Must have

Installed git and Node.js

Building JSGL

First clone repository

git clone https://github.com/Moderrek/JSGL.git

Enter the JSGL directory and install development dependencies
```
cd JSGL
npm install
```
Run build script
- npm run build - Builds deployment bundle, types declaration and docs -> /dist /docs
- npm run build:prod - Builds deployment bundle -> /dist
- npm run build:dev - Builds mapped bundle -> /dist
- npm run build:types - Builds types declaration -> /dist
- npm run build:docs - Builds web docs for JSGL -> /docs

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Tymon Woźniak (owner) <tymon.student@gmail.com>
Project: https://github.com/Moderrek/JSGL