Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Moderrek/JSGL

Repository files navigation

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

  • DOM

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

  1. First clone repository
    git clone https://github.com/Moderrek/JSGL.git
  2. Enter the JSGL directory and install development dependencies
    cd JSGL
    npm install
  3. Run build script
    • npm run build - Builds deployment bundle, types declaration and docs -> /dist and /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

About

Client-side JavaScript library for creating web 2D games. Focusing at objective game. JS Game Library

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

Contributors

AltStyle によって変換されたページ (->オリジナル) /