diff options
Diffstat (limited to 'md_README.html')
| -rw-r--r-- | md_README.html | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/md_README.html b/md_README.html index 5d9dcae5..67e9865c 100644 --- a/md_README.html +++ b/md_README.html @@ -85,23 +85,29 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <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> +<h2>Introduction</h2> +<p>YAGE stands for Yet Another Game Engine. It is a 2D game engine that is being developed for the game <a href="https://github.com/ymherklotz/Arider">Arider</a>. However, it will also be general game engine library for any other 2D games.</p> +<p>YAGE uses OpenGL for rendering of 2D graphics. OpenGL was chosen because it is the most crossplatform Graphics API, and not as low level as Vulkan.</p> +<p>Yage uses GLFW for the creation and viewport as it is lightweight and easy to manage. However, these features are completely wrapped behind the YAGE API.</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. To do this, a Component Entity System will be used to manage the different systems in the game engine and make it as modular as possible. Systems can easily be added to the game engine, and new entities with custom Components can also be created by the user.</p> +<p>The game engine also supports asynchronous logging by using an <code>Active</code> class that creates a new thread, and queues any functions that are sent to it. This can help debugging programs, as one can increase the minimum log level of the game engine to any required resolution. This output can also be piped to a file without slowing down the program.</p> +<p>The full documentation of the API 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> +<h2>Build and Testing</h2> +<p>To compile YAGE, create a build directory from the base directory. 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 to build the library and run tests on it.</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> -<h2>License </h2> +<h2>Future Improvements</h2> +<p>The first step is to have full support of 3D meshes with their corresponding textures, and making a useful API to interact with the 3D YAGE library.</p> +<p>Secondly, improvements to the Entity Component System</p> +<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> </div></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Wed Jan 10 2018 19:56:50 for YAGE by  <a href="http://www.doxygen.org/index.html"> +Generated on Tue Feb 13 2018 19:22:08 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> |