diff --git a/README.md b/README.md index 83ca1ed..2099868 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ ------ JavaScript framework similar to XNA to develop simple 2D games on HTML5 +## Motivation +XNA is a framework with a managed runtime environment provided by Microsoft that facilitates video game development, but was discontinued in 2013. +This little project tries to adapt a part of XNA to JavaScript, using some classes similar to XNA and extending the framework with other classes that help on the 2D game development, like Sprite, Camera, Circle, etc. + +## Execution flow +The main entry point is the **_Program_** class, which instances the **_Game_** class, in charge of running and maintaining the game loop. + +![alt text](https://github.com/Rockam/XgameJS/blob/master/execution_flow.jpg "Execution flow") + ## How to use it You can simply pick the _src/JS/XNA_Classes/Game.js_ class, copy it wherever you want, and modify it in order to develop your own game. Then create an HTML file and reference all the classes you use in there. @@ -10,12 +19,4 @@ The main demo is a classic **_Rayman_** style level that I've made with XgameJS, ![alt text](https://github.com/Rockam/XgameJS/blob/master/Rayman_screenshot.png "Rayman demo") -## Execution flow -The main entry point is the **_Program_** class, which instances the **_Game_** class, in charge of running and maintaining the game loop. - -![alt text](https://github.com/Rockam/XgameJS/blob/master/execution_flow.jpg "Execution flow") - -## Motivation -XNA is a framework with a managed runtime environment provided by Microsoft that facilitates video game development, but was discontinued in 2013. -This little project tries to adapt a part of XNA to JavaScript, using some classes similar to XNA and extending the framework with other classes that help on the 2D game development, like Sprite, Camera, Circle, etc.