Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
enginmanap authored Aug 16, 2018
1 parent 16c6d7e commit fbe0448
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# LimonEngine

LimonEngine is a 3D first person shooter engine, developed as a hobby, to acquire a deeper knowledge of 3D game engine programming.
Limon is a multi platform 3D game engine mainly focusing on first person games. Focus of its development is ease of use and ease of study.

It can load a wide variety of models and skeletal animations thanks to Assimp, has realtime directional and point lights/shadows and physics.
## Feature Overview

You can extend the engine capabilities using exposed API, and design maps using the build-in map designer.
- 3D rendering with dynamic lighting/shadows
- Rigid body physics
- 3D spatial sound
- AI
- Built-in editor with animation sequencer
- C++ API for extensibility, and dynamic loading of extensions

You can check out the [project web site](http://enginmanap.github.io/limonEngine/status.html)
For details check out the [project web site](http://enginmanap.github.io/limonEngine/status.html)

If you want to test the engine, there are releases for Windows, Ubuntu and MacOS, [check them out](https://github.com/enginmanap/limonEngine/releases/)
Prebuilt binaries for Windows, Linux and MacOS can be [found here](https://github.com/enginmanap/limonEngine/releases)

Documentation is served on [readthedocs](https://limonengine.readthedocs.io/en/latest/)

For a demonstration, check out the video :

[![Mayan Map with sound](http://img.youtube.com/vi/1OHS3TJ1q6o/0.jpg)](http://www.youtube.com/watch?v=1OHS3TJ1q6o)


## Building

Dependencies can be installed on Ubuntu 17.10 using:
Expand Down Expand Up @@ -44,7 +50,7 @@ $ cmake ../

### In editor mode:
- Since static and dynamic objects rigidbodies are not generated by same logic, mass settings can't be changed after object creation.
- In animate objects are not allowed to have AI
- Inanimate objects are not allowed to have AI
- You can create animations for doors etc. in editor. For animation creation, time step is 60 for each second.
- When a new animation is created by animation editor, the object used to create the animation assumed to have this animation. You can remove by using the remove animation button.

Expand Down

0 comments on commit fbe0448

Please sign in to comment.