=======
Welcome
=======

Welcome to Limon Engine's documentation!
========================================

Limon is a multi platform 3D game engine. Focus of its development is ease of use and ease of study. It has builtin editor for maps, animations and GUIs.

Prebuilt binaries for Windows, Linux and MacOS can be `found here <https://github.com/enginmanap/limonEngine/releases>`_

If you want to check out what Limon engine is and can do, you can check out about.

The documentation is separated in three major sections:

1. How to use the engine and build in editor to create games.
2. Extending capabilities using Limon API.
3. Engine architecture and internals.

Contribute
----------

If you are having issues, or if you think some awesome feature is missing, please let us know using the issue tracker.
Also if you want to chat, there is a Discord channel.

- Issue Tracker: https://github.com/enginmanap/limonEngine/issues
- Source Code: https://github.com/enginmanap/limonEngine
- Discord: https://discord.gg/gqprbFd

License
-------

The project is licensed under the LGPL license.

.. toctree::
   :maxdepth: 1

   self
   GettingStarted
   UsingTheEditor
   AssetManagement
   ExtendingByAPI/index
   EngineArchitecture
   RenderingPipeline
   SupportingSystems
   RoadMap
   authors

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`