Skip to content

Commit

Permalink
update readme file to include more up to date information
Browse files Browse the repository at this point in the history
  • Loading branch information
enginmanap committed Jun 3, 2018
1 parent 835f4d6 commit 1cc27b2
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,44 @@

LimonEngine is a 3D first person shooter engine, developed as a hobby, to acquire a deeper knowledge of 3D game engine programming.

It can load any model using Assimp, model animations are implemented. but since there is no AI, the first animation is played repeatedly. Realtime lighting and shadows are also implemented. It allows physical interaction with player and objects.
It can load a wide variety of models and skeletal animations thanks to Assimp, has realtime directional and point lights/shadows and physics.

You can extend the engine capabilities using exposed API, and design maps using the build-in map designer.

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

For a demonstration, check out the video at https://youtu.be/OkMz1MGk9NE
For a demonstration, check out the video :

[![Limon Engine New map and Editor](http://img.youtube.com/vi/2rBYDD6Z52Q/0.jpg)](https://youtu.be/2rBYDD6Z52Q)


##Building

Dependencies can be installed on Ubuntu 17.10 using:

sudo apt-get install libassimp-dev libbullet-dev libsdl2-dev libsdl2-image-dev libfreetype6-dev libtinyxml2-dev libglew-dev build-essential libglm-dev libtinyxml2-dev

After that, in repository directory
mkdir build
cd build
cmake ../


##Running

### Start up:
- Engine take a parameter as path of world to load
- If no parameter passed, falls back to /Data/Maps/World001.xml
Note: Save map button in editor mode saves the map to /Data/Maps/CustomWorld001.xml
- Engine tries to load custom trigger extentions as "libcustomTriggers.dll" for windows and "libcustomTriggers.so" for linux. If you use a custom action in a map you have to include these in the library file.

### In Application:
- Pressing 0 switches to debug mode, renders physics collision meshes and disconnects player from physics ( flying and passing trough objects)
- Pressing " key switches to editor mode, which allows creating maps.
- Pressing + and - changes mouse sensitivity.
- wasd for walking around and mouse for looking around as usual.

### In editor mode:
- Since static and dynamic objects are not generated by same logic, mass settings can't be changed after object creation.
- In animate 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.

0 comments on commit 1cc27b2

Please sign in to comment.