This repository contains the source code for Regrowth Studios Vorb Game Engine.
NOTE: If you are wanting to set up Vorb to work with Seed of Andromeda, then visit follow the intructions on the SoA github page.
This guide will walk you through setting up as a contributor to or user of the Vorb project. There is a basic requirement of having several packages installed prior to being able to develop. We support all three major operating systems: Windows, Mac and Linux.
If you're intending to just use the Vorb engine, great! Be sure to check out the Vorb wiki and feel free to add any issues you have with the engine for the awareness of the engine contributors.
Before beginning to make pull requests for the engine, please take a moment to use the following resources to get an idea of how to contribute, what you might be able to contribute to specifically, and to meet some of the other contributors.
IMPORTANT: Before following any of the instructions linked below for the platforms we support, please do take a second to fork the repository! If you are new to GitHub, you can do so by clicking the "fork" button on the top right of this page.
If you have cloned the repository before forking, no worries! We can fix it, by following these instructions.
Now we're forked, follow the link to the section on setting up for your OS of choice:
Now you have a copy of the code, and perhaps have played with it a little, why not give it a whirl?
Windows + R
cmd
cd c:\
mkdir -p repos
c:\
cd c:\repos
git clone --recurse-submodules https://github.com/YOUR_GITHUB_NAME/SoACode-Public.git soa
cd c:\repos\soa
brew install git
cmd + space
Terminal
mkdir ~/repos
cd ~/repos
git clone --recurse-submodules https://github.com/YOUR_GITHUB_NAME/SoACode-Public.git soa
cd ~/repos/soa
sudo emerge -DuNqa gcc # for gcc
sudo emerge -DuNqa clang # for clang
sudo pacman -S gcc
sudo pacman -S clang
sudo apt-get install gcc
sudo apt-get install clang
sudo yum install gcc
sudo yum install clang
sudo emerge -DuNqa git
sudo pacman -S git
sudo apt-get install git
sudo yum install git
mkdir ~/repos
cd ~/repos
git clone --recurse-submodules https://github.com/YOUR_GITHUB_NAME/SoACode-Public.git soa
cd ~/repos/soa
cd ~/repos/soa
git checkout develop # or whichever branch you want
git pull --recurse-submodules
mkdir build
cd build
cmake ../ # plus whatever options you'd like to select.
cmake --build ./ # plus whatever options you'd like to select (e.g. --clean-first)
So, you've accidentally cloned the repository before forking it, eh? No problem. Just run the following git commands inside of the repository and everything will be as it should be!
Firstly, if you still haven't, fork the repository!
Now you have a fork we want to set origin
of each of your local repository (which is the default remote repository to push changes to) to your corresponding forked repository on GitHub:
# Assuming we're already inside the top-level directory of your Vorb repository.
git remote set-url origin https://github.com/YOUR_GITHUB_NAME/Vorb.git
That's it! It's all fixed. :)