Frostform Engine

A simple 2D game engine built with C++ and Raylib, featuring sample games including Pong and Space Invaders.

Features

• Core Engine Components:

  • GameObject base class for game entities
  • Collider system for collision detection
  • Background rendering
  • Circle shape utilities
  • Vector2 math utilities

• Sample Games:

  • Pong: Classic paddle ball game with scoring
  • Space Invaders: Retro space shooter with invaders and bullets

Future Plans

In the future, I plan to integrate pure OpenGL, DirectX, and Vulkan rendering backends for enhanced graphics capabilities, cross-platform support, and add 3D rendering features.

Prerequisites

Required Tools

• CMake (version 3.16 or higher)

  • Download: https://cmake.org/download/
  • Installation: Follow the installer for your platform

• C++ Compiler

  • MSVC (Windows): Install Visual Studio Community (free)
    • Download: https://visualstudio.microsoft.com/downloads/
    • Select "Desktop development with C++" workload during installation
  • GCC (Cross-platform):
    • Windows: Install MinGW-w64 from https://www.mingw-w64.org/
    • Linux/macOS: Usually pre-installed or available via package manager
  • Clang (Cross-platform):
    • Windows: Available through Visual Studio or LLVM installer
    • Download: https://llvm.org/

• Raylib Library (automatically downloaded and built via CMake FetchContent)

  • No manual installation required - handled by the build process

Building

1. Clone or download the project

Option 1a: Manual Build

2. Navigate to the project root directory
3. Create a build directory:

   mkdir build  # create build directory
   cd build     # enter build directory
   

4. Generate build files with CMake:

   cmake ..     # execute into the ./build directory
   

5. Build the project:

   cmake --build . --config Release   # execute into the ./build directory - builds the code into the .exe into release folder
   

Option 1b: Manual Build

2. Open the project
3. Generate build files with CMake::

   cmake -S . -B build    # CMAKE initial build
   

4. Build the project:

   cmake --build build    # builds the code into the .exe
   

Option 2: Using Build Script (Windows)

2. Run the PowerShell build script from the project root:

.\scripts\build.ps1 -BuildType Release

0. To clean and rebuild:

.\scripts\build.ps1 -Clean -BuildType Release

Running

After building, the executable will be located in build/bin/Release/. Run the game engine to start with the default game, or modify the code to select different games.

Project Structure

• include/ - Header files for engine components and games
• src/ - Source files for implementation
• build/ - Build artifacts (generated by CMake)
• scripts/ - Build and utility scripts
• CMakeLists.txt - CMake build configuration
• README.md - Project documentation
• CHANGELOG.md - Version history and changes
• CONTRIBUTING.md - Guidelines for contributors
• LICENSE - MIT license file
• .clang-format - Code formatting configuration
• .editorconfig - Editor configuration
• VERSION - Current version number

Contributing

Feel free to contribute by adding new games, improving the engine, or fixing bugs. Please ensure code follows C++ best practices and includes appropriate documentation.

Greetings

I would like to express my sincere gratitude to the following:

• Raylib – for providing a simple and powerful library for videogame programming, and to its community and developers for their continuous work and support.

  • Website: https://www.raylib.com/
  • License: zlib/libpng

• AIV (Accademia Italiana Videogiochi) – and its teachers for their guidance, support, and for helping me build the knowledge and foundation to implement this code.

  • Website: https://www.aiv01.it/

License

This project is licensed under the MIT License - see the LICENSE file for details.