Enki is an open source robot simulator written in C++. It provides collision and limited physics support for robots evolving on a flat surface. On a contemporary desktop computer, Enki is able to simulate groups of robots hundred times faster than real-time.
© 1999-2017 Stéphane Magnenat and others (full list)
This section presents the robots available in the standard distribution, alongside their supported features. Enki is extensible: users can add their own custom robots.
Enki is free software released under the GNU General Public License version 2. We kindly ask the authors of any publication arising from research using this software to add a reference to it as explained in the documentation.
This section explains how to compile Enki from the source distribution.
To compile Enki and programs who depend on it, you need:
In addition, if you want the support for the viewer and Python bindings, you need:
Those short instructions assume that you want to use "make" to build Enki. If you want to use another build environment, such as Microsoft Visual Studio, please refer to cmake documentation. Once you have downloaded and extracted the source distribution, you can create the Makefiles by running:
cmake .
and then build Enki by running:
make
You can also change the build options by running:
ccmake .
or
cmake-gui .
prior to cmake.
To use the library with a project using CMake, add these lines in your project:
find_package(enki REQUIRED)
Then you can include the Enki directory with:
include_directories(${enki_INCLUDE_DIR})
And link to the library, and optionally its viewer, by:
target_link_libraries(YOUR_TARGET ${enki_VIEWER_LIBRARIES} ${enki_LIBRARY} ...)
Inside your code, include Enki and the viewer using:
#include <enki/PhysicalEngine.h>
#include <viewer/Viewer.h>
HTML documentation (including examples and cookbooks) can be generated by the
doc
target of the build system. Doxygen tool can be downloaded from
http://www.doxygen.org/
If you want to contribute to Enki, please open an issue to discuss your idea or submit a pull request with a prototype.