Getting Started

Robert Konrad edited this page Oct 21, 2017 · 5 revisions
Clone this wiki locally

Git (a versioning system), Node.js (scripting tool used by the included build tool) and a C++ IDE (Visual Studio for Windows, Code::Blocks or CLion for Linux, XCode for OSX) should be installed to use Kore.

To get started, git clone a Kore project recursively:

git clone --recursive

Building a Kore project works in two steps: First the integrated build system koremake is called using Node.js - cd to your project directory and execute "node Kore/make". This creates an IDE project in the build subdirectory. Open it up and run the project in your IDE. At that point you can work in your IDE like usual. However when you add additional source files you eventually need to modify korefile.js, which defines which files are added to a project by koremake.

Kore/make has several options. If used without options, it will generate a default project for the platform's default IDE and graphics API.

To get an overview of options, the option --help.

Relevant for Windows users are:

  • The Visual Studio version -v --visualstudio which can be vs2010, vs2012, vs2013, vs2015, or vs2017 (default)
  • The graphics API -g --graphics, either be direct3d9, direct3d11 (default), direct3d12, opengl or vulkan

So to create a solution for VS 2013 with OpenGL, you can use

node Kore/make -g opengl -v vs2013