Skip to content

The game engine under Orion Editor

Notifications You must be signed in to change notification settings

epitech-mirroring/Stellar-Forge

Repository files navigation

Stellar Forge

Stellar Forge

EPITECH Project C++ SFML CMake Fedora Windows

Stellar Forge is the custom game engine that powers R-Type: Reborn, designed from the ground up to support networked gameplay, modern graphics, and advanced game mechanics.

Table of Contents

Project Purpose

Stellar Forge is a custom-built game engine designed to power networked video games, like R-Type: Reborn. It was created to support modern game development techniques, such as multi-threading, network synchronization, and real-time 2D rendering, all while offering flexibility for game designers using the Orion Editor.

This engine allows us to modernize classic games like R-Type by enabling new game mechanics, improved graphics, and optimized performance, while demonstrating best practices in software engineering.

Dependencies & Requirements

To build and run Stellar Forge, you will need:

  • C++ compiler supporting C++17 or later
  • SFML (Simple and Fast Multimedia Library) for graphics, audio and input (For the 2D Game Engine)
  • CMake for building the project
  • Raylib for graphics, audio and input (For the 3D Game Engine)
  • GLM (OpenGL Mathematics) for vector and matrix operations
  • Conan for managing dependencies

You can install the dependencies using your platform's package manager or follow the official documentation for each tool.

Supported Platforms

  • Windows 10+
  • Linux (Fedora, Ubuntu, etc.)

Build Instructions

To build Stellar Forge, follow these steps:

Windows

  1. Clone the repository to your local machine.
  2. Open a terminal and navigate to the project directory.
  3. Launch the following commands:
./build-windows.ps1
  1. Accept the installation of the dependencies.
  2. The project will be built in the build directory and the libraries will be copied at the root of the project.

Linux

  1. Clone the repository to your local machine.
  2. Open a terminal and navigate to the project directory.
  3. Launch the following commands: (You need to have sudo rights)
sudo ./build-linux.sh
  1. Accept the installation of the dependencies.
  2. The project will be built in the build directory and the libraries will be copied at the root of the project.

Documentation

You can find the documentation for Stellar Forge in the R-Type: Reborn repository or in the Documentation repository. You can also find the documentation on the following website: Stellar Forge Documentation. If you have any questions or need help, feel free to reach out to the authors.

Example Games

Stellar Forge can be used to create a wide range of games, from classic arcade shooters to modern multiplayer experiences. Here are some examples of games that can be built using Stellar Forge:

  • Flappy-Bird-Reborn: is a clone of the iconic game named Flappy Bird. Your goal is to survive and avoid the pipes that appears near you. click here to try this game!
  • R-Type-Reborn: is a modern reimagining of the classic arcade shoot 'em up, combining nostalgic gameplay with new features and enhancements. click here to try this game!
  • Demo Sample 3D Engine: is a simple 3D game engine that demonstrates the capabilities of the Stellar Forge engine 3D. click here to try the demo!

Authors & Contact

Marius-P1
Marius PAIN

AubaneNourry
Aubane NOURRY

6im0n
Simon GANIER-LOMBARD

RenardFute
Axel ECKENBERG

landryarki
Landry GIGANT

Useful Links