Skip to content

Latest commit

 

History

History
124 lines (75 loc) · 4.59 KB

BUILDING.md

File metadata and controls

124 lines (75 loc) · 4.59 KB

Build instructions

Operating Systems

Windows (10/11)

1. Install Visual Studio Community (Or any other IDE)

  1. Download latest version from visualstudio.microsoft.com
  2. Launch downloaded Visual Studio installer
  3. Select "Desktop development with C++" before installation
  4. Add "C++ Clang tools for Windows" inside Installation details (optional)
  5. Unselect "vcpkg package manager" inside Installation details we will use our own! <---
  6. Finally click Install button to begin installation

2. Install Git

You may use default Git install options or chose any other default Git editor instead of Vim.

3. Install CMake

  1. Download latest release version of installer from cmake.org
  2. Select "Add CMake to the system PATH for the current user" during installation

4. Install Vulkan SDK

To build the project you will only need The Vulkan SDK Core components.

5. Clone Repository

  1. Open Terminal or CMD app to execute following commands
  2. Change current working directory using cd command where to clone repository. (Google it)
  3. Run git clone --recursive https://github.com/cfnptr/garden command to download repository
  4. Run cd garden/ to enter repository directory

Note! Use appropriate github link if Garden engine is used as a third-party library.

6. Install vcpkg package manager

  1. Repoen CMD or Terminal app as Administrator. (Right click the app)
  2. Run scripts/update-vcpkg.bat command from the repository scripts/ directory
  3. Reopen CMD or Terminal app to get updated system environment variables.

Or

  1. Follow installation steps from learn.microsoft.com (Better to choose C:\vcpkg path)
  2. Run vcpkg integrate install command using Terminal or CMD app to make packages available user-wide
  3. Add vcpkg to the System Environment Variables. (Google it)

6. Install required packages

  1. Run vcpkg install zlib:x64-windows-static openssl:x64-windows-static using Terminal or CMD app

Alternatively run install-packages.bat from the repository scripts/ directory

Ubuntu (22.04/24.04)

1. Install Visual Studio Code (Or any other IDE)

  1. Download and install latest version from code.visualstudio.com
  2. Install "C/C++" And "CMake Tools" extensions inside Visual Studio Code

2. Install required packages

  1. Run sudo apt-get update command using Terminal app
  2. And sudo apt-get install git cmake gcc g++ gdb clang lld lldb zlib1g-dev libssl-dev xorg-dev

3. Install Vulkan SDK

Use "Ubuntu Packages" tab and "Latest Supported Release" instructions for that.

macOS (14/15)

1. Install Xcode (Or any other IDE)

  1. Download and install latest version from App Store app
  2. Run xcode-select --install command using Terminal app to install Xcode tools

2. Install required packages

  1. Install Homebrew package manager from brew.sh
  2. Run brew update command using Terminal app
  3. And brew install git cmake zlib openssl

3. Install Vulkan SDK

  1. Download latest version from vulkan.lunarg.com for macOS
  2. During Select Components screen "System Global Installation" should be checked

To build the project you will only need The Vulkan SDK Core components.

Build Project

To build the project run one of the scripts using Terminal, Git Bash or build it using IDE.

Visual Studio (2022)

  1. Open Visual Studio 2022 IDE
  2. Click "Open a local folder" and open the repository folder
  3. Click Build -> Build All to build the project

Visual Studio Code (VS Code)

  1. Open Visual Studio Code IDE
  2. Install "C/C++" And "CMake Tools" extensions
  3. Click File -> Open Folder... and open the repository folder
  4. Click Yes in "Would you like to configure project..."
  5. Select one of the compiler Kits in the opened window
  6. Click Build button at the bottom bar to build the project