...

Prerequisites

To set up the development environment, you need to install the following tools.

• Vagrant: a tool for managing and configuring Virtual Machines. Download the latest distro of Vagrant here
• VirtualBox: Download the latest version of Virtualbox. You need both the main application and the "Oracle VM VirtualBox Extension Pack", available here. Check that the versions are the same 😉
• Git: make sure to go on Github and create an account.

Installation

The idea is that Vagrant uses VirtualBox to provision a virtual machine for our pre-configured image, box. This virtual machine contains a fully integrated development environment, including everything you'll need to develop software for our team. Now open up a Git Bash window (on Windows) or a terminal window (on Mac), and run the following commands:

...

Please use the email that's associated with your GitHub account.

Update existing box

to update existing boxes to ubuntu-20.04, navigate to your box folder

...

After updating the box, you may need to reconfigure your git configurations, follow the steps above.

Usage

# Bring up the virtual machine
# This step is only necessary after a reboot
vagrant up
# Access the box
vagrant ssh
# Move to the firmware_xiv folder
cd shared/firmware_xiv
# See https://github.com/uw-midsun/firmware_xiv #usage for some common commands
make [cmd] ...

# To exit the virtual machine press CTRL + D
# Stop the virtual machine
vagrant halt

...

Now at this point you are ready to move onto the Firmware Tutorial!

FAQ

Q: I've cloned the firmware repo and I'm in the directory, but I can't build it.

...