Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 2.36 KB

SETUP_LINUX.md

File metadata and controls

51 lines (42 loc) · 2.36 KB
Raw

Setting up Rubeus on Linux

Created by SDSLabs with ❤️

Setting up the build environment

  1. You can use any IDE/text-editor you fancy for contributing to Rubeus.
  2. Rubeus uses Visual Leak Detector v2.5.1 for catching memory leaks. Unfortunately, it is not available for Linux, which means that you can use some other dynamic code profiling tool like Valgrind if you like. You can also just ignore VLD altogether.
  3. Install CMake (preferably a version above or same as 3.11).
  4. Clone this repository:
$ git clone git@github.com:sdslabs/Rubeus.git

Acquiring dependencies:

  1. The system package manager (Apt and Apt-Get) on Ubuntu can be commanded to get system specific libraries to run Rubeus. Run:
$ sudo apt install mesa-common-dev libxinerama-dev libxcursor-dev mesa-vulkan-drivers vulkan-utils cmake-gui libglew-dev libglfw3-dev 
$ sudo apt-get install libgl-dev xorg-dev libglu1-mesa-dev libx11-dev libxrandr-dev libxi-dev libudev-dev mesa-common-dev libopenal-dev libdevil1c2 libdevil-dev libsfml-dev
$ hash -r

Initialising CMake

First build the Project Manager

  1. Navigate to Rubeus' cloned repository
  2. Run cmake -D_PROJECTMANAGER=1 ./ Note: Rubeus uses an in-source CMake build

In case you want to build both Rubeus Engine and Project Manager in one go without the GUI Run cmake -D_DEV=1 ./ Ignore warnings related to unused variables Note: The engine would be built with the previous project it was built or in case of the first run, with the ping pong example game

After buildig the Project Manager once you may use it's GUI to run the relevanct CMake as shown in this tutorial

Building Rubeus using Makefiles

  1. After running CMake, you will find that CMake has generated a Makefile. To use this Makefile to build Rubeus, just run this in Rubeus/:
$ make
  1. This will generate a binary in the RubeusCore/ProjectManager/ directory by the name ProjectManager. Run it using:
$ cd RubeusCore/ProjectManager/ && ./ProjectManager

Use the Project Manager GUI to further configure your Engine build

We are done! Remember to go through the contribution guidelines for further guidance.