Skip to content
/ RAPIER Public

Renderer Agnostic Paramount Imagination Engine Reborn

License

Notifications You must be signed in to change notification settings

daavllc/RAPIER

Repository files navigation

RAPIER

Renderer Agnostic Paramount Imagination Engine Reborn

RAPIER

Purpose

Provide the backbone for graphical projects to be built upon. Creating a render API agnostic graphics engine enables the best possbile performance on any platform by using the API built for that platform. Creating a multi-platform engine also enables projects to be more easily ported to different platforms with less hassle.

Details


Current status/roadmap

  • Initial Release
  • Documentation
  • FORGE
    • Initial Release
    • Physics Collider Visualizers
    • Play/Pause
    • Initial implementation
  • RAPIER
    • POMMEL
      • Initial implementation
    • 3D
      • Physics
    • 2D
      • Physics
      • Initial implementation
    • Features
      • HDR
  • Platforms
    • Desktop
      • Windows
      • Linux
      • MacOS
    • Mobile
      • iOS
      • Android
    • Console
      • Sony
      • Microsoft
      • Nintendo
  • Render APIs
    • Metal
    • DirectX
    • Vulkan
    • OpenGL

Installation

There are currently no releases, so you must download and compile from source. Check the Contributing section for instructions.

Contributing

Visual Studio 2017 or 2019 is recommended, RAPIER is officially untested on other development environments while we focus on a Windows build and feature development.

  1. Download the repository

    • Run git clone --recursive https://github.com/daavofficial/RAPIER.
    • Near the rop right, click Code > Download ZIP
      • Extract the zip file
  2. Creating the solution

    1. Run Win-Setup.bat found in the scripts folder. This will download any missing dependencies for RAPIER.
      • If the VulkanSDK is not installed, you will be prompted to download and install it. Once downloaded, follow the steps it provides to install it. After it is installed, please re-run Win-Setup.bat to verify it's installation
      • If premake is not found in the vendor/premake/bin folder, you will be prompted to download premake.
    2. After all dependencies are installed, Win-GenProjects.bat will be executed automatically, and will generate a Visual Studio solution file for you to use.

If you make changes to any premake5.lua files, or if you want to regenerate the project files, re-run Win-Setup.bat.


License: MIT

Copyright © 2022 DAAV, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.