From 51aa385ce8cfba5438de5b3e9ee90ec7d8509628 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alexis=20Laferri=C3=A8re?= Date: Sun, 13 Dec 2015 13:29:02 -0500 Subject: [PATCH] lib/gamnit: intro README.md MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Alexis Laferrière --- lib/gamnit/REAME.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 lib/gamnit/REAME.md diff --git a/lib/gamnit/REAME.md b/lib/gamnit/REAME.md new file mode 100644 index 0000000..9d60cc0 --- /dev/null +++ b/lib/gamnit/REAME.md @@ -0,0 +1,18 @@ +Portable game and multimedia framework for Nit + +This framework is based on the portability framework _app.nit_ and the OpenGL ES 2.0 standard. + +It is modular, different parts of the framework are available through different entry points: + +* `gamnit` provides low-level abstractions over some services of OpenGL ES 2.0, like textures, shaders and programs. + It defines the basic methods to implement in order to obtain a working game: `App::frame_core` to update the screen + and `App::accept_event` to receive user inputs. + +* `simple_2d` provides an easy to use API for 2D games based on sprites. + Clients of this API must redefine `App::update` to update the game logic and fill `App::sprites` with objects to draw. + +* `cameras` provides cameras classes to produce MVP matrices which can be fed to shaders. + +* `limit_fps` redefines existing services of gamnit to limit the framerate to a client-defined value. + +* `network` provides a simple communication framework for multiplayer client/server games. -- 1.7.9.5