Snow Leopard Engine

Yet another game engine group project written in C++ with OpenGL 4.6

SnowLeopardEngine/SnowLeopardEngine - GitHub

This project is a group project of COMP5530M(23/24 Group Project, 37449), University of Leeds.

Group Members:

Name Responsibility
Kexuan Zhang Leader. Architecture, Core Systems, Rendering, Editor, Audio, Report
Ziyu Min Associate Leader. Rendering, Shaders, Report
Jubiao Lin Physics, In-Game GUI, Poster
Simiao Wang Physics, Poster, Showcase Video
Ruofan He GamePlay (Path-Finding)
Haodong Lin Animation
Yanni Ma Editor

Features

  • Modern OpenGL (4.6)
  • Unity-like Shaders (DzShader)
  • PhysX for Physics Simulation
  • PBR Rendering
  • Post-processing Effects
  • Skeletal Animations
  • Simple In-game GUI

And more!

Examples

TODO

Game

Prerequisites

Windows

  • XMake
  • Visual Studio 2019 (or above) with C++ Desktop Development Environment
  • Git 2.1 (or above)
  • .NET 8 SDK

Avoid long-path limit: Execute with system manager permission (Powershell):

New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" ` -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
git config --system core.longpaths true

Install .NET 8 SDK through winget:

winget install Microsoft.DotNet.SDK.8

macOS

  • XMake
  • XCode 13 (or above)
  • Git 2.1 (or above)
  • .NET 8 SDK

To install XMake on macOS, you can use HomeBrew:

brew install xmake

If you don’t have HomeBrew, you can also install it through bash command:

bash <(curl -fsSL https://xmake.io/shget.text)

To install .NET 8 SDK on macOS, please download the installer here.

Linux

  • XMake
  • GCC / Clang
  • Git 2.1 (or above)
  • .NET 8 SDK

Ubuntu / Raspberry Pi OS / Other Debian Systems

To install XMake, simply use curl:

bash <(curl -fsSL https://xmake.io/shget.text)

Install other packages:

sudo apt-get install build-essential cmake git clang libx11-dev libxrandr-dev libxrender-dev libglvnd-dev libxinerama-dev libxcursor-dev libxi-dev

To install .NET 8 SDK on Linux, please download the installer here, or you can install from package managers.

Other Linux Systems

TODO

Build Instructions

Clone Repo

git clone git@github.com:SnowLeopardEngine/SnowLeopardEngine.git --recursive

Build with XMake

Windows

cd SnowLeopardEngine
./build.bat

macOS / Linux

cd SnowLeopardEngine
./build.sh

Run Examples, for example, SnowLeopardEditor 

xmake run SnowLeopardEditor

3rd Party libraries

Reference List

License

This project is licensed under the MIT license.