Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 2.29 KB

README.md

File metadata and controls

44 lines (29 loc) · 2.29 KB

Codacy Badge Average time to resolve an issue Percentage of issues still open

Turnip Engine

Turnip is my toy game engine that follows the principles of the "yet another" mentality.

Getting Started

Turnip doesn't have prebuilt binaries, so if you want to use it, you'll need to build it yourself. It uses Premake 5 to generate project files, but it has only been tested with Visual Studio.

Prerequisites

You'll need to install the following to build this project:

If the SDK fails to include it automatically, you must provide an environment variable named VULKAN_SDK under VulkanSDK/<version>. Additionally, you may need to add an environment variable to use premake5.

Installation

  1. Clone the repository

    git clone --recurse-submodules https://github.com/DatDarkAlpaca/turnip-engine
  2. Generate the project If you're building on a Windows machine, you can use the build.cmd file to execute the Python script. This automatically calls premake, so you must specify the project file of your choice.

    .\build <action: vs2022, vs2021, gmake, ...>
  3. Compile the project Use the generated project files to build the project. After that, you should have a working copy under turnip-engine/build/bin/{configuration}/turnip-editor.)

License

This project is licensed under the MIT License - see the LICENSE file for details