Skip to content
This repository was archived by the owner on Dec 18, 2023. It is now read-only.

DevReaper0/Spirit-Engine-Development

Repository files navigation

Spirit Engine License

Spirit Engine

Spirit Engine is primarily an early-stage interactive application and rendering engine for Windows, Mac, and Linux. Currently not much is implemented.

Supported Platforms

Spirit Engine currently supports:

  • Computer OS:
    • Windows Supported
    • Linux Supported
    • MacOS Supported
  • Mobile OS:
    • Android Not Supported
    • IOS Not Supported

Windows, Mac, and Linux are currently supported with plans for Android/IOS support in the future.

Getting Started

Visual Studio 2017 or 2019 is recommended, Spirit Engine is officially untested on other development environments whilst I focus on a Windows build.

You can clone the repository to a local destination using git:

git clone --recursive https://github.com/DaRubyMiner360/Spirit-Engine-Development

Make sure that you do a --recursive clone to fetch all of the submodules!

Windows

Premake is provided as premake5.exe in the repository. Execute and follow the install instructions.

Linux

Premake is provided as premake5-linux.tar.gz in the repository. To download and install it, follow the instructions:

$ wget https://github.com/DaRubyMiner360/Spirit-Engine-Development/raw/master/vendor/bin/premake/premake5-linux.tar.gz
$ tar -xzvf premake5-linux.tar.gz
$chmod +x premake5-linux # make premake executable
$ sudo cp premake5-linux /usr/bin/

$ premake5 --help

Spirit Engine has extra development dependencies needed for Linux. The following packages are needed to compile the project:

  • libxcursor
  • libxrandr
  • libxinerama
  • libxi

Arch

On Arch and Arch derivative distributions, install these packages by running:

sudo pacman -S libxcursor libxinerama libxi

Debian

On Debian and Debian derivative distributions, install these packages by running:

sudo apt install libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libglu1-mesa-dev

Spirit Engine is configured and compiled with:

premake5 gmake2
make

The Plan

The plan for Spirit Engine is two-fold: to create a powerful 2D and 3D engine.

Main features to come:

  • Fast 2D rendering (UI, particles, sprites, etc.)
  • High-fidelity Physically-Based 3D rendering (this will be expanded later, 2D to come first)
  • Support for Mac, Linux, Android and iOS
    • Native rendering API support (DirectX, Vulkan, Metal)
  • Fully featured viewer and editor applications
  • Fully scripted interaction and behavior
  • Integrated 3rd party 2D and 3D physics engine
  • Procedural terrain and world generation
  • Artificial Intelligence

Short term goals :

By the end 2020, I want to make a game using Spirit Engine. Not like the time I made a game in one hour using the engine, but this time by using the proper tools that would be required to make a game with Spirit Engine. This means we need to add a full 2D workflow:

  • Design the game scene by using Hazelnut, the Spirit Engine editor,
  • Test the game inside Spirit Editor, including the ability to save/load the created game,
  • Load and play the game inside Sandbox.

We want everyone to be able to play the game on all desktop platforms (Windows, Mac and Linux). When this is implemented, another attempt at the "Creating a game in one hour using Spirit Engine" will be made to see how far the engine has become.

Twitter

Youtube

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors