VIRTUOS_Docs/sites/getstarted.qmd

---
title: "Project Setup"
---
If you want to take a look inside a project, there are currently three important repositories:

- VIRTUOS_Playground: The repository contains the Unreal Engine Project
- VIRTUOS_Assets: Contains all Project related assets like 3D-Models, Graphics etc.
- VIRTUOS_Documents: Contains all written Documents
- VIRTUOS_Docs: The Documentation in QUarto (which you're reading right now)

# Setting up the project with UE5

If you're familiar with Git, you'll likely already know how to get the files.

```bash
git pull https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Docs.git
```

If you're not comforatable with the command line, you can install a Git GUI like Github Desktop:

Hit `File -> Clone repository`

![](../img/Clone1.png)

Enter the repository from `code.virtuos.world` you want to clone, e.g. https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Playground.git

![](../img/Clone2.png)


# Dependencies

The project uses the following external Plugins:

- VR Expansion Plugin, see https://github.com/mordentral/VRExpansionPlugin
- SPUD: Steve's Persistent Unreal Data library, see https://github.com/sinbad/SPUD

The Plugins are already in the /Plugins folder

# Building the project

Note: To build the project, you'll need Visual Studio installed on your system.


<ol>
  <li>Right click the .uproject file and hit `Generate Visual Studio project files`. </li>
  <li>Open the newly generated .sln file in Visual Studio. From there, hit `Build -> Build solution`.</li>
</ol>