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

To build this project, you'll need to install the following:

• Python 3
• Conan 2.0
• Vulkan
• Premake 5
• Mono
• .NET 6.0

You may need to set these environment variables if they aren't automatically detected:

1. Vulkan: Set VULKAN_SDK to point to your Vulkan SDK installation (e.g., C:/Vulkan/).
2. Mono: Likewise, set MONO_SDK to point to your Mono installation directory (e.g., C:/Program Files (x86)/Mono). You must also have .NET installed and properly configured - the project calls dotnet commands internally.
3. Premake: Ensure the directory containing premake5 is added to your system's PATH.

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