UNPKG

jsge

Version:

Javascript Game Engine

114 lines (78 loc) 5.3 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="expires" content="Wen, 05 Jun 2024 07:01:00 GMT"> <title>JSDoc: Home</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="stage-title">Home</h1> <h3> </h3> <section> <article><h1>Javascript Game Engine</h1> <p>This engine was designed to simplify creating games on javascript. <br> No external libraries are used for drawing, no TypeScript, strict OOP structure - no cycle dependencies. It is easy to use and debug. <br> <br> <img src="Debug.gif?raw=true" alt="Alt text" title="Title"></p> <h3>Advantages:</h3> <ul> <li>OPP modular structure.</li> <li>Webgl 1 under the hood, wide browser support.</li> <li>Masks and webgl <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/blendFunc">blend effects</a>.</li> <li>Assets manager for files preloading. Images, Audio, Image Atlas (Atlas.xml), etc.</li> <li>Tilemaps with tilesets support from <a href="https://www.mapeditor.org">Tiled editor</a>.</li> <li>Unlimited size tilesets. 800x800 cells, with 16x16 pixels [example] (https://codepen.io/yaalfred/pen/zYegGGb)</li> <li>Frame animations for sprites and tiles.</li> <li>Spine 2d skeletal animation as a plugin.</li> <li>Collisions for tiles and objects.</li> <li>Boundary(collision shapes) drawing as a debug option. <img src="boundaries_draw.png?raw=true" alt="Boundaries draw" title="Boundaries draw"></li> </ul> <h3>Tilemaps support:</h3> <ul> <li>Full file formats support: <ul> <li>JSON (.tmj, .json)</li> <li>XML (.tmx, .xml)</li> <li>Internal tilesets (as part of tilemap file)</li> <li>External JSON tilesets (.tsj, json)</li> <li>External XML tilesets (.tsx, .xml)</li> <li>Attached images uploading</li> </ul> </li> <li><a href="https://doc.mapeditor.org/en/stable/manual/editing-tilesets/#tile-animation-editor">Animated tiles support</a></li> <li><a href="https://doc.mapeditor.org/en/stable/manual/editing-tilesets/#tile-collision-editor">Tiled collision shapes</a>.</li> </ul> <h3>How to run examples:</h3> <ol> <li>git submodule update --init</li> <li>npm i</li> <li>npm start</li> <li>visit localhost:9000</li> </ol> <p>API docs and tutorials: <a href="https://jsge.reslc.ru">jsge.reslc.ru</a> <br> github: <a href="https://github.com/ALapinskas/jsge">https://github.com/ALapinskas/jsge</a> <br> issues: <a href="https://github.com/ALapinskas/jsge/issues">https://github.com/ALapinskas/jsge/issues</a> <br> npm: <a href="https://www.npmjs.com/package/jsge">https://www.npmjs.com/package/jsge</a></p></article> </section> </div> <nav> <div class="switcher"><ul><li class="active"><a href="/">1.5.9</a></li></div> <h2><a href="/">Home</a></h2><h3>Classes</h3><ul><li><a href="DrawCircleObject.html">DrawCircleObject</a></li><li><a href="DrawConusObject.html">DrawConusObject</a></li><li><a href="DrawImageObject.html">DrawImageObject</a></li><li><a href="DrawLineObject.html">DrawLineObject</a></li><li><a href="DrawObjectFactory.html">DrawObjectFactory</a></li><li><a href="DrawPolygonObject.html">DrawPolygonObject</a></li><li><a href="DrawRectObject.html">DrawRectObject</a></li><li><a href="DrawShapeObject.html">DrawShapeObject</a></li><li><a href="DrawTextObject.html">DrawTextObject</a></li><li><a href="DrawTiledLayer.html">DrawTiledLayer</a></li><li><a href="GameStage.html">GameStage</a></li><li><a href="GameStageData.html">GameStageData</a></li><li><a href="IExtension.html">IExtension</a></li><li><a href="INetwork.html">INetwork</a></li><li><a href="IRender.html">IRender</a></li><li><a href="ISystem.html">ISystem</a></li><li><a href="ISystemAudio.html">ISystemAudio</a></li><li><a href="RenderLoop.html">RenderLoop</a></li><li><a href="RenderLoopDebug.html">RenderLoopDebug</a></li><li><a href="System.html">System</a></li><li><a href="SystemSettings.html">SystemSettings</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-application_scheme.html">Application Scheme</a></li><li><a href="tutorial-assets_manager.html">Assets Manager</a></li><li><a href="tutorial-common_issues.html">Common Issues</a></li><li><a href="tutorial-how_to_add_and_use_audio.html">How to add and use audio</a></li><li><a href="tutorial-how_to_do_animations.html">How to Create Animations</a></li><li><a href="tutorial-how_to_load_and_use_tilemaps.html">How to Load and Use Tilemaps</a></li><li><a href="tutorial-quick_start.html">Quick Start</a></li><li><a href="tutorial-spine_animations.html">How to Add Spine Animations</a></li><li><a href="tutorial-stages_lifecycle.html">Stages Lifecycle</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Jun 18 2025 06:53:54 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>