diff options
Diffstat (limited to 'index.html')
| -rw-r--r-- | index.html | 58 |
1 files changed, 14 insertions, 44 deletions
@@ -8,13 +8,6 @@ <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> @@ -28,6 +21,7 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="yage.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">YAGE  <span id="projectnumber">v0.1.4.0</span> @@ -69,20 +63,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </ul> </div> </div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('index.html','');}); -</script> -<div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" @@ -102,31 +82,21 @@ $(document).ready(function(){initNavTree('index.html','');}); <div class="title">YAGE </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><div class="image"> -<img src="https://travis-ci.org/ymherklotz/YAGE.svg?branch=master" alt="master-build"/> -</div> -<h2>Introduction </h2> -<p>YAGE stands for Yet Another Game Engine. It is a game engine that is being developed for a game called <a href="https://github.com/ymherklotz/Arider">Arider</a>. It uses OpenGL and GLFW for the window creation and management and graphics. It is also going to be a general game engine for use with other games in the similar style.</p> -<p>The inspiration for this game engine is to learn about OpenGL and create an optimised 2D game engine with a simple API that can be used to easily create simple 2D games.</p> -<p>The full documentation can be seen <a href="https://www.yannherklotz.com/YAGE">here</a>.</p> -<h2>Installation and usage </h2> -<p>To use YAGE for your own game, you should link it as a static library and include the <a href="/include/YAGE/yage.h">yage.h</a> header in your project. To link the project using cmake, the library has to be added as a subdirectory and then linked with the name <code>yage</code>.</p> -<h2>Build and Testing </h2> -<p>To compile YAGE, create a build directory from the base dirqectory. Then call cmake and point it to the directory containing. <a href="/CMakeLists.txt">CMakeLists.txt</a>. For example, one can use the following commands</p> -<p>``` shell mkdir -p build cd build cmake .. ```</p> -<p>The test suite can then be run using</p> -<p>``` shell cd build/tests && ctest ```</p> +<div class="textblock"><p>YAGE (Yet Another Game Engine) is a game engine that was written to learn about graphics and eventually be used to program games. It focuses mostly on tile based 2D games but it will eventually be expanded to handle orthographic views and finally full 3D.</p> +<h2>Guides </h2> +<p>Below are some guides for different aspects of the game engine and how to use it.</p> +<ul> +<li><a class="el" href="spritebatch_guide.html">Sprite Batching</a>: Used to draw efficient 2D sprites and tiles.</li> +<li><a class="el" href="logger_guide.html">Logger</a>: Asynchronous logger.</li> +</ul> <h2>License </h2> -<p>Copyright (c) 2017 Yann Herklotz Grave <a href="#" onclick="location.href='mai'+'lto:'+'ymh'+'er'+'klo'+'tz'+'@gm'+'ai'+'l.c'+'om'; return false;">ymher<span style="display: none;">.nosp@m.</span>klot<span style="display: none;">.nosp@m.</span>z@gma<span style="display: none;">.nosp@m.</span>il.c<span style="display: none;">.nosp@m.</span>om</a> – MIT License, see file <a href="/LICENSE">LICENSE</a> for more details. </p> +<p>Copyright (c) 2017 Yann Herklotz Grave <a href="#" onclick="location.href='mai'+'lto:'+'ymh'+'er'+'klo'+'tz'+'@gm'+'ai'+'l.c'+'om'; return false;">ymher<span style="display: none;">.nosp@m.</span>klot<span style="display: none;">.nosp@m.</span>z@gma<span style="display: none;">.nosp@m.</span>il.c<span style="display: none;">.nosp@m.</span>om</a> MIT License, see LICENSE file for more details. </p> </div></div><!-- contents --> -</div><!-- doc-content --> <!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated on Sat Jan 6 2018 21:19:57 for YAGE by - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> +<hr class="footer"/><address class="footer"><small> +Generated on Wed Jan 10 2018 18:44:07 for YAGE by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> </body> </html> |