Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 3.86 KB

Linux-Build-Instructions.md

File metadata and controls

60 lines (36 loc) · 3.86 KB
Raw

#Linux Build Instructions

Note: These instructions have been created by building OSVR-Core on a bare bones Ubuntu 14.04. The same steps would work on other Linux distributions as well.

Compiler: Clang or GCC/G++

Either one of those should work. You will need to build libfunctionality separately from OSVR-Core.

Required tools/libraries:

Unless specified otherwise, you can use the package manager to get the tools mentioned below

  • Git
  • CMake (3.0 or newer). Package manager had a version 2.x, so you should get the latest version from http://CMake.org or from PPA
  • OpenCV - libopencv-dev
  • Boost libraries (1.44 or newer) You don't need all of them but you'll need at least : libboost1.xx-dev, libboost-thread1.xx-dev (includes required system, date-time and chrono), libboost-program-options1.xx-dev, libboost-filesystem1.xx-dev)
    • A bug in Boost 1.58.0 was previously thought to make it incompatible, but nobody's had any issues with it recently, so we might no longer be triggering the (build) error condition anymore.
  • libusb1 - libusb-1.0-0-dev

CMake notes: If you are new to CMake then read the following guidelines that you should follow to build OSVR-Core and other libraries, otherwise you can skip this section. To build a project with CMake you need to create a build directory inside your project main directory such as OSVR-Core/build. Next from the build directory, run the following CMake command:

cmake .. (This calls CMakelist.txt from directory above and tells it to create config files in current build folder folder)

It will configure the project for you and let you know if are missing any libraries. Once configured you can run make to build the project

Build these libraries first

Once you have the tools above, you can build the following libraries before you begin building OSVR-Core.

  • libfunctionality library

git clone --recursive https://github.com/OSVR/libfunctionality.git

  • jsoncpp library, if your distribution doesn't include it. If your distribution does include it, the package it has is probably fine, OSVR isn't too picky. If you do end up building jsoncpp, you'll want to run CMake with flags below for simplest use.

git clone --recursive https://github.com/VRPN/jsoncpp

cmake .. -DJSONCPP_WITH_CMAKE_PACKAGE=ON -DJSONCPP_LIB_BUILD_SHARED=OFF -DCMAKE_CXX_FLAGS=-fPIC

Don't forget make install after building jsoncpp.

This should be all the libs/tools that you will need to build OSVR-Core on Linux. CMake messages are very descriptive, if you are missing something, just install it and run cmake .. again

Ready to build OSVR-Core

To get OSVR-Core you'll need to clone it from the main repo (don't forget --recursive flag to get all submodules)

git clone --recursive https://github.com/OSVR/OSVR-Core.git

Finally just make, and watch it build (or grab a soda and read through more OSVR tutorials, like how to build apps with Unity or Unreal)

Known issues (temporary)

If you do not get the Added device: com_osvr_Multiserver/OSVRHackerDevKit0 when running osvr-server and you're using an HDK:

  • Make sure you're building with the latest master branch of the source (and that, if you've updated the source recently, that you've done a git submodule update --recursive to update the submodules too), since the earlier HIDAPI bug requiring the non-windows-workaround branch has been fixed.
  • If you are using one of the HDK headsets, you will also need to run osvr-server as root, or you can install the following udev rules (See issue #330 for more information): https://gist.github.com/rpavlik/98d21e14a7e6eeb52e95