Vorb

This repository contains the source code for Regrowth Studios Vorb Game Engine.

Getting Started

This guide will walk you through setting up as a developer for Vorb. There is a basic requirement of having several packages installed prior to being able to develop. In addition, we support all three major operating systems:

Installing and building:

• Windows
• Mac
• Linux

Contributing

• Wiki
• Issues

Windows

Required pre-setup

Tools

• Compiler: Microsoft Visual Studio Community Edition
• Software Version Control: Git
• MSVS SVC Plugin: MSVS Git Plugin
• CMake: Cmake

Vorb Dependencies

• SDL v2: Github
• GLEW v1.11.0: Github
• Boost v1.57.0: Github
• Lodepng vN/A: Github

Installation

1. Open a dos window.

Windows + R
cmd

2. Create a folder to hold the repositories

cd c:\
mkdir -p repos

3. Clone the Vorb repository

c:\
cd c:\repos
git clone --recurse-submodules [email protected]:RegrowthStudios/Vorb.git vorb

Building

1. Pull latest code

cd c:\repos\soa
git checkout develop
git pull --recurse-submodules

2. Run build script

build.bat

Mac

Required pre-setup

1. Compiler: Xcode

• Software Version Control: Git Optionally, with Homebrew: brew install git
• Preferred editor: Sublime Text and optional packages
  • PackageControl
  • CMake - CMake.tmLanguage
  • GitGutter - A Sublime Text 2/3 plugin to see git diff in gutter
  • SublimeCodeIntel - Full-featured code intelligence and smart autocomplete engine
  • SublimeLinter -- Interactive code linting framework for Sublime Text 3
  • SublimeLinter-cpplint -- This linter plugin for SublimeLinter provides an interface to cpplint.
  • SublimeLinter-pep8 - SublimeLinter plugin for python, using pep8.
  • SublimeLinter-contrib-clang - https://sublime.wbond.net/packages/SublimeLinter-contrib-clang

Installation

1. Open a terminal.

cmd + space
Terminal

2. Create a folder to hold the repositories

mkdir ~/repos

3. Clone the Seed of Andromeda repositories

cd ~/repos
git clone --recurse-submodules [email protected]:RegrowthStudios/SoACode.git soa

Building

1. Pull latest code

cd ~/repos/soa
git checkout develop
git pull --recurse-submodules

2. Run build script

./build.sh

Linux

Required pre-setup

1. Compiler: gcc or clang
   • Install per your preferred operating system package control...
   • Portage:

   sudo emerge -DuNqa gcc   # for gcc
   sudo emerge -DuNqa clang  # for clang
   

   • PacMan:

   sudo pacman -S gcc
   sudo pacman -S clang
   

   • Apt:

   sudo apt-get install gcc
   sudo apt-get install clang
   

   • Yum:

   sudo yum install gcc
   sudo yum install clang
   

• Software Version Control: Git
  • Portage:

  sudo emerge -DuNqa git
  

  • PacMan:

  sudo pacman -S git
  

  • Apt:

  sudo apt-get install git
  

  • Yum:

  sudo yum install git
  

Installation

1. Open a terminal.
2. Create a folder to hold the repositories

mkdir ~/repos

3. Clone the Seed of Andromeda repositories

cd ~/repos
git clone --recurse-submodules [email protected]:RegrowthStudios/SoACode.git soa

Building

1. Pull latest code

cd ~/repos/soa
git checkout develop
git pull --recurse-submodules

2. Make sure you have required development libraries
   • Apt:

   sudo apt-get install libglew-dev libglfw-dev libglm-dev
   

3. Run build script

./build.sh