Skip to content

Getting started with SpaRcle Engine

Installation

You can get your SpaRcle Engine with the following methods:

  • Releases page (stable, recommended)
  • GitHub Actions (latest, unstable)
  • FlatHub (Linux only, planned)
  • Build it yourself! (advanced, instructions below)

Supported platforms

  • Windows 10/11
  • Linux
    • GLFW (unstable)
    • X11 (unstable)
    • Wayland (planned)
    • Flatpak (planned)
  • Android
    • VR Meta Quest (planned)
  • Web (planned)
  • iOS (not planned in near future)
  • MacOS (not planned in near future)
  • Consoles (not planned in near future)

Supported compilers

  • MSVC (stable)
  • GCC (stable)
  • Clang (stable)
  • MinGW

Building

Prerequisites

  1. Clone repository via the command "git clone https://github.com/SpaRcle-Studio/SREngine"
  2. Switch to the `dev` (latest) or `master` (stable), or another one, branch via the command "git checkout branch_name"
  3. Run command "git submodule update --init --recursive" in repository folder

To checkout the repository faster, use the following command: 

git clone --recurse-submodules --depth 1 --shallow-submodules https://github.com/SpaRcle-Studio/SREngine.git