SolarSim

I built this to learn OpenGL, and somewhere between the shader errors and matrix math, I ended up with something that actually looks like space.

Demo of the solar system

Documentation

This project uses Doxygen to generate API documentation.

Generating docs

doxygen Doxyfile

This will generate the documentation in the docs/ folder. You can open the index.html file in a web browser to view the documentation locally.

Alternatively, the documentation is hosted via GitHub Pages and can be viewed here

Build & Run

Required System Libraries

• OpenGL (3.3+)
• CMake (3.10+)
• C++20 compiler (reference)
• GNU Make (optional if using CMake directly)

Included Dependencies (No installation needed)

The following are included as submodules or source code:

• GLFW - Window and input management
• GLM - 3D mathematics library
  
• GLAD - OpenGL function loader
• stb_image - Image loading library
• googletest - C++ testing framework
• assimp - Asset loading library
• Dear ImGui - C++ GUI library

Commands

Using Makefile (Recommended)

# Clone with submodules
git clone --recursive https://github.com/dvuvud/solarsim.git
cd solarsim
 
# Build and run using the provided Makefile
make build
make run
 
# Or build and run in one command
make all
 
# Clean build artifacts
make clean

Using CMake Directly

# Clone with submodules
git clone --recursive https://github.com/dvuvud/solarsim.git
cd solarsim
 
# Configure and build
cmake -B build
cmake --build build --target solarsim
 
# Run the application
./build/solarsim # Linux/macOS
build\Debug\solarsim.exe # Windows

Controls / Keybinds

Key	Action
W	Move camera forward
S	Move camera backward
A	Move camera left
D	Move camera right
Space	Move camera up
Left Shift	Move camera down
R	Toggle time reversal (rewind / forward)
P	Toggle pause / unpause
G	Toggle grid
Tab	Toggle mouse capture / release
Scroll	Zoom in & out
Escape	Quit application