Skip to content

FlexHaufen/Lychee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lychee

A simple, fast & lightweight voxel engine written in pure C++.

Important

Lychee is currently in the early alpha stage of development.
There is no guarantee the engine will run.

Dependencies

Setup

Requirements

  • Vulkan SDK
  • Cmake Version Version 3.28 or higher
  • MSVC 19.39.33521.0 or higher

Setup Repo

  1. Clone

    git clone [email protected]:FlexHaufen/Lychee.git
  2. Setup submodules in ./Lychee

    git submodule update --init --recursive

    ImGui Has to be on docking branch

  3. Configure Cmake

    • In VScode press F1 - Type Cmake Configure - Press Enter
    • Select "Visual Studio Compiler 2022 Release - amd64" - Press Enter

Build

  • To Build Press F7 - NOTE: By default it will build a Debug-Build

Run

To Run the .exe file via F5 you first need to configure a launch.json in your .vscode folder. Like the example below

  • To Run Press F5 - NOTE: By default it will run a Release-Build
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Release",
            "type": "cppvsdbg",
            "request": "launch",
            "program": "${workspaceFolder}/build/bin/release/LycheeApp.exe",
            "args": [],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "console": "internalConsole"
        },
        {
            "name": "Debug",
            "type": "cppvsdbg",
            "request": "launch",
            "program": "${workspaceFolder}/build/bin/debug/LycheeApp.exe",
            "args": [],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "console": "internalConsole"
        }
    ]
}

Acknowledgements

About

A simple, fast & lightweight voxel game engine.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages