PROJECT YUKI ENGINE

Yuki Engine
~~~ Logo designed by Arisu ~~~

About Yuki Engine

Build Yuki

1. Required tools

• Compiler: MSVC (Windows), clang (LLVM), gcc (Linux)
• Build tool: CMake (Version >3.20), [Additional you can use Ninja for better perfomance of clang and gcc]
• Package manager: vcpkg

2. Install tools

• MSVC: Visual Studio Installer
• clang: LLVM Home page or install on linux

  # Arch linux https://archlinux.org/packages/extra/x86_64/llvm/
  $ sudo pacman -Sy llvm

  # Ubuntu https://apt.llvm.org/
  $ sudo apt-get install llvm

• gcc:

  # Arch linux https://archlinux.org/packages/extra/x86_64/llvm/
  $ sudo pacman -Sy gcc

  # Ubuntu https://apt.llvm.org/
  $ sudo apt-get install gcc

• CMake: CMake home page

  # Arch linux https://archlinux.org/packages/extra/x86_64/llvm/
  $ sudo pacman -Sy cmake

  # Ubuntu https://apt.llvm.org/
  $ sudo apt-get install cmake

• vcpkg: Offical tutorial

  # Clone vcpkg repository from Microsoft's github
  git clone https://github.com/Microsoft/vcpkg.git
  
  # Run bootstrap script
  # Windows
  .\vcpkg\bootstrap-vcpkg.bat
  # Linux
  ./vcpkg/bootstrap-vcpkg.sh
  
  # Run this line if you are using windows
  .\vcpkg integrate install

3. Install dependencies

• Install all required dependencies using vcpkg

  vcpkg install assimp freetype glad glfw3 fmt

4. Build Yuki

• Configure CMake build target

cd ./YukiEngine
# Replace [...] with the matched value in your computer
cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg path]/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE:STRING=[build type] -S./ -B./build -G [Your build system]

• Build

cmake --build ./build

• Enjoy <3