Rune Engine Documentation

Welcome to the RuneEngine!

You can use the Rune Engine API to create 2D games. This is the manual that will show you how to do that.

If it's your first time using Rune, you should check out the Programming Guides.

Getting Started

Visual Studio 2017 or 2019 is recommended. Rune is officially untested on other development environments and is only supported by Windows.

You can check out the latest release of the engine here: Engine Downloads

Setting up a New Rune Project

1. Add the path "Rune Engine Directory"/include in the C/C++ settings of your project.
2. Add the path "Rune Engine Directory"/lib in the linker settings of your project.
3. Link the LIB files in the linker settings of your project. Use RuneEngine-d.lib and RuneEngine-d.dll for debug builds.
4. Move the DLL files into your game's working directory.
5. Declare RUNE_PLATFORM_WINDOWS in the preprocessor definitions of your project.
6. #include <RuneEngine.h> in the files using the engine.

Warning

Make sure you are building in 64-bit, Rune does not support 32-bit.

Engine Features

• Custom 2D renderer
• Custom Physics Engine
• Customizable Game Objects
• Particle System
• Lighting System
• Physically Accurate Collisions
• Animated Sprites
• Debug Interface with ImGUI
• Tile work flow and sprite work flow

In-Engine Dynamic Lighting

Engine Issues

Found something that you think isn't working the way it's supposed to? Please submit a bug report on the github repository: Report an Issue