VIRTUOS_WORLD/VIRTUOS_Docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update Code Docs

Browse source
This commit is contained in:
Simeon "Waldo" Wallrath 2026-01-07 22:07:11 +01:00
parent bd65c6c24d
commit 25805d40e5
41 changed files with 10977 additions and 2287 deletions
Download patch file Download diff file Expand all files Collapse all files

26
sites/getstarted.qmd
View file

@ -3,14 +3,14 @@ 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)
- [VIRTUOS_Playground](https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Playground): The repository contains the Unreal Engine Project
- [VIRTUOS_Assets](https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Assets): Contains all Project related assets like 3D-Models, Graphics etc.
- [VIRTUOS_Documents](https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Documents): Contains all written Documents
- [VIRTUOS_Docs](https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Docs): The Documentation of this Project (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.
If you're familiar with Git, you'll likely already know how to get the files from the repository:
```bash
git pull https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Docs.git
@ -22,7 +22,7 @@ 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
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)
@ -31,20 +31,22 @@ Enter the repository from `code.virtuos.world` you want to clone, e.g. https://c
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
- [VR Expansion Plugin](https://github.com/mordentral/VRExpansionPlugin)
- [SPUD: Steve's Persistent Unreal Data library](https://github.com/sinbad/SPUD)
- [SUDS: Steve's Unreal Dialogue System](https://github.com/sinbad/SUDS)
- [StevesUEHelpers: Steve's UE Helper Plugin Library](https://github.com/sinbad/StevesUEHelpers)
The Plugins are already in the /Plugins folder
The Plugins are already in the /Plugins folder and should build with the project without errors. For manual installation, see the respective Documentation.
# Building the project
Note: To build the project, you'll need Visual Studio installed on your system.
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>
Note: This may take a while.