galaxy

galaxy

Real-Time C++23 Game/App Engine. Built on data-driven design principles and agile software engineering.

Building

Note that only 64bit is supported.

Windows:

Visual Studio 2022

Major Components:

Desktop development with C++
Game development with C++

Minor Components:

Windows Universal CRT SDK
Windows SDK 10.0.20348.0
Windows Universal C Runtime

Building Instructions:

git clone --recursive https://github.com/DomRe/galaxy.git galaxy
git submodule update --init --recursive
Open galaxy.sln and go Build -> Rebuild Solution, in either Debug or Release mode.

Linux:

Only Ubuntu is supported.

CMake v3.24

Ubuntu 22.04.3 LTS OR WSL2 - Ubuntu

sudo apt update && sudo apt upgrade -y
sudo apt install git curl cmake llvm clang build-essential libfreetype-dev libz-dev pkg-config mesa-utils libglu1-mesa-dev mesa-common-dev

MacOS:

No.

Scripts:

There are additional helper scripts located in the scripts folder.

In order to run these, you require MSYS2 or WSL2.

Documentation

See online documentation.

Features

- (A)sync Timers
- Entity Component System
- Config Loader
- Prefabs
- OpenGL 4.6 w/ Extensions Renderer (i.e. Bindless Textures).
- Error handling.
- Flexible logging.
- Event Handling.
- Virtual File System.
- File Dialogs.
- Input Handling, both callback and poll.
- LDTK mapping support.
- Various algorithms and math stuff.
- (De)compression support.
- Platform abstraction.
- Resource and asset handling.
- Unity style scene Management.
- Lua and JSON scripting support.
- State management for things like animations and movement.
- ImGUI + Nuklear for UI.
- Lua bindings for Nuklear UI.
- Supercluster editor to be used in conjunction with coding. Not standalone.

Contributing / Feedback / Issues

Feel free to open an issue for feedback, bug reports, ehancements, issues, etc, and pull requests for contributions. (Don't forget to add yourself to the credits section below.)

Credits

• Uses SMAA. Copyright (C) 2011 by Jorge Jimenez, Jose I. Echevarria, Belen Masia, Fernando Navarro and Diego Gutierrez.
• sercode.ttf.
  • Used in various icons and logos.
• galaxy image.
  • Image Credit: ESA/Hubble & NASA, A. Filippenko.
  • See NASA media guidelines.
  • Used for non-commerical purposes.
• Supercluster Icon and Logo.
  • Image Credit: NASA/JPL-Caltech/University of Wisconsin
  • See NASA media guidelines.
  • Used for non-commerical purposes.
• Any "dependency" i.e. "software library" should/will usually have an associated LICENSE/COPYING/AUTHORS file included.
• Resources used for testing:
  • Various from OpenGameArt.
• https://github.com/ocornut/imgui/issues/707
• https://materialdesignicons.com/