Galaxy

🚀Galaxy is a cross-platform 3D game engine.

Galaxy is still under development from scratch.

Prerequisites

To build 🚀Galaxy, you must first install the following tools.

Windows 10/11

• Visual Studio 2019 (or above) with C++ Desktop Development Environment
• CMake 3.20 (or above)
• Git 2.1 (or above)
• Vulkan SDK 1.3.261.1 (or above)

Ubuntu 22.04 or above (Linux or WSL2)

Install prerequisite packages:

wget -qO- https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo tee /etc/apt/trusted.gpg.d/lunarg.asc
sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-jammy.list http://packages.lunarg.com/vulkan/lunarg-vulkan-jammy.list
sudo apt-get update
sudo apt-get install build-essential cmake git clang libx11-dev libxrandr-dev libxrender-dev libglvnd-dev libxinerama-dev libxcursor-dev libxi-dev mesa-vulkan-drivers vulkan-sdk

MacOS

• XCode 13 (or above)
• CMake 3.20 (or above)
• Git 2.1 (or above)
• Vulkan SDK 1.3.261.1 (or above)

Build Galaxy

Clone this repository:

git clone --recursive git@github.com:zzxzzk115/GalaxyEngine.git

Build on Windows

Build it automatically:

Just double-click BuildWindows.bat or you can simply use Jetbrains CLion to debug or release.

Build it manually:

cmake -S . -B build

Then open the generated solution file with Visual Studio.

Build on Linux / WSL2

Build it automatically:

chmod +x *.sh && ./BuildLinux.sh

Build on MacOS

Build it automatically:

chmod +x *.sh && ./BuildMacOS.sh

Build it manually:

cmake -S . -B build -G "Xcode"

Then open the generated project file with XCode.

Acknowledgments

We would like to thank the following projects for their invaluable contribution to our work:

• Hazel (Game Engine & Tutorials)
• Piccolo (Game Engine & Tutorials)
• GameEngineFromScratch (Game Engine & Tutorials)
• gamemachine (Game Engine & Tutorials)
• AsunaEngine (Game Engine & Tutorials)
• levk (Game Engine)
• FlaxEngine (Game Engine)
• glfw (Window Abstraction)
• imgui (GUI)
• spdlog (Logger)

License

This project is licensed under the GPLv3 license.