Installation

Setting Up and Installing the Vagrant box:

---

Please make sure to follow each step correctly.

Prerequisites:

The entire DU-Robocup system can be installed using Vagrant, a provider for virtual boxes. This should let you set up the entire build and work environment without having to deal with dependencies (everything should just work perfectly). Note: These instructions are for 64bit Linux Operating Systems, though they can easily be adapted to other operating systems with a few changes

Note for Windows Users: You need to install some UNIX tools for the installation to work properly. Download git for Windows here and select "Use Git and optional Unix tools for Windows Command Prompt" if you wish to always use Command Prompt. Otherwise you MUST use the Git Bash terminal to complete the following instructions.

1. Download the latest version of Vagrant from https://www.vagrantup.com/downloads.html. AVOID USING YOUR PACKAGE MANAGER TO DOWNLOAD VAGRANT. While rolling release Linux distributions like Arch and Gentoo likely have the up to date version, distro's like Ubuntu in our experience won't and this will cause issues.

2. Download Virtual Box. You can use your package manager for this, we suggest getting the guest-additions package as well. The latest versions can be found here. If you have issues with getting virtualbox to work, the Arch Wiki has a good guide.

3. Create an empty folder on your computer, on a disk with at least 5Gb of free space. This will contain the Vagrant environment.

4. Open a terminal in this new folder and type vagrant init

Downloading Our Vagrant File:

Change directories to the new folder which will contain your vagrant environment and download the file here: https://raw.githubusercontent.com/DU-RoboCup/vagrant-install/master/Vagrantfile and place it in this directory. It is necessary to replace the existing 'Vagrantfile' with our new version if one already exists.

Provisioning the Vagrant Environment:

1. With the terminal you opened earlier, which should already located in the vagrant directory you created enter the command vagrant up. You'll answer a few questions to help us get set up, and then you're on your way! NOTE: This script will take a long time, so be patient. This will configure the Vagrant Environment, and install all of the dependencies/code. After this script is done, you're ready to start developing!

Connecting to the Vagrant Environment

To connect to the virtual machine (headless linux) all you need to do is navigate to the directory containing your Vagrantfile and type the command vagrant ssh. If the virtual box is not started, you will need to use the command vagrant up. If you want to shut down the VM you can use vagrant halt.

Installing and Building the Engine:

To build the engine once the vagrant box is installed, all we have to do is run the command cd NAO/NAO-engine to switch to the root directory for the engine. Then run ./build.sh local cross to build the entire engine (with GUI support). That's all it takes! No having to worry about dependencies or issues with compilation, as it is all boxed up!

Exiting the Vagrant Environment:

When you're done working on things in the vagrant environment, typing exit will exit the ssh session, and then typing vagrant halt will shutdown the vagrant instance and save your current changes.