Raptor

Scary-efficient game engine for VR platforms, targeting PC and console.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

In order to begin hacking on the engine, you'll first need to set up your development enviroment with all the shiny new features of the modern digital world. On linux systems, some quick apt magic should do the trick:

$ sudo apt-get update
$ sudo apt-get install build-essential software-properties-common -y
$ sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
$ sudo apt-get update
$ sudo apt-get install g++-8 cmake

Installing

Once you have your build environment set up, all the rest of the engine software and dependencies will be automagically installed once the engine is built. Just run:

$ ./Engine/Build/build.sh

And that's it! If you find that you've messed something up, or your binaries have turned into doc-eating monsters of doom, don't panic. Removing all bins, libs and temporaries are as simple as cleaning for a fresh build, like so:

$ ./Engine/Build/clean.sh

Be warned: this will clear all your build caches (for the engine source and all dependancies!), so running clean will require a full rebuild.

Deployment

To get this working on your system, just navigate to Raptor's root directory and enter:

$ ./Engine/Binaries/Raptor

This will launch the engine in its entirety (i.e. editor, build tools, project management, etc).

Built With

• CMake - Automated build tool
• GLFW - Dependency Management
• Love - Perfect patties are made with love, not magic

Contributing

There currently is no code of conduct, and there isn't an official contributing markdown page either :P If you still consider your soul worthy of helping out on the project, don't hesitate to email us at hybridalpaca[at]gmail[dot]com. Please, use common sense when copying that email address.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Seth Traman - Lead Developer - cellman123

See also the list of contributors who participated in this project.

License

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

Acknowledgments

• Thanks to all the folks over at GitHub who made open-source code sharing possible

• Special thanks to PurpleBooth for this snazzy Markdown template