Welcome to the Nim wrapper of Urho3D!

This is a Nim wrapper of the full Urho3D game engine. It has been built using c2nim in a largely automated fashion, and it's currently built against version 1.32 of Urho3D. It's verified to work on Linux, OSX and Windows.

To use it you need:

1. Nim compiler version 0.10.3 or later.
2. Urho3D version 1.32 (exactly) compiled as a library for your platform.
3. A bit of patience.

Install Nim

To get Nim version 0.10.3 (which is current devel, not released yet) you have to follow the bootstrap instructions at the bottom of the download page and replace -b master with -b devel for both clone commands.

When that is done, just put bin/nim in your PATH either by adding the bin directory to your path or making a softlink to the nim compiler. Nim will then find everything it needs relative to its own position.

If all works out running nim --version should show 0.10.3.

Install Urho3D

To compile Urho3D for your platform we refer to Urho3D build documentation which is very specific and not that hard to perform. On Linux and OSX cmake_gcc.sh works fine, your mileage may vary.

When Urho3D is built (no need to install it) you will find the library (libUrho3D.a for example) in the Lib directory. Copy it into the lib directory (create it if missing) here in Urhonimo.

On Windows you will need both a .dll as well as a .lib file. The DLL can be downloaded from Urho3D's website. See the following instructions for building the .lib file.

Compiling Urho3D on Windows

On Windows, this wrapper requires Visual Studio 2013 to be installed together with the Visual C++ compiler (cl.exe).

You must compile the examples from the "Developer Command Prompt" which can be found in your start menu (if you are on Windows 8+ you may need to perform the actions described here).

After running cmake_vs2013.bat you should see a Urho3D.sln file in the build directory of where Urho3D resides. Open this solution file in VS 2013. You should then be able to build Urho3D by pressing Ctrl+Shift+B.

You can then copy the resulting .lib file from the lib directory into Urhonimo's lib directory.

After that you should be able to compile the examples. If you get linker errors similar to '_ITERATOR_DEBUG_LEVEL': value '2' doesn't match value '0' then you may need to compile Urho3D in release mode or vice versa.

Compiling and running examples

To compile an example, go into the examples directory and compile like this:

$ cd examples
$ nim cpp character.nim

...or any other example like hello.nim.

Note that nim c (compiling by generating C) does NOT work and produces strange errors. You need to compile via C++ using nim cpp.

To run the resulting binary you need the CoreData and Data directories from Urho3D, just copy or link from your Urho3D directory into the examples directory.

Then you should be able to run hello and character, and it should work on Windows, Linux and OSX.

Happy hacking!