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

Updating

Browse source
This commit is contained in:
Simeon "Waldo" Wallrath 2025-04-08 11:37:06 +02:00
parent afb22a9f0c
commit eadf26a230
22 changed files with 966 additions and 3810 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.quarto/idx/index.qmd.json
View file

File diff suppressed because one or more lines are too long

3
.quarto/xref/INDEX
View file

@ -23,5 +23,8 @@
},
"sites/overview.qmd": {
"overview.html": "a690ee7d"
},
"sites/codesnippets/getstarted.qmd": {
"getstarted.html": "fdab1932"
}
}

2
.quarto/xref/d99f7c3a
View file

@ -1 +1 @@
{"entries":[],"headings":["welcome-to-the-documentation","features"]}
{"entries":[],"headings":[]}

23
_quarto.yml
View file

@ -13,26 +13,25 @@ website:
search: true
contents:
- text: "Overview"
href: sites/overview.qmd
href: index.qmd
- section: "Getting Started"
contents:
- sites/getstarted.qmd
- section: "Code Snippets"
contents:
- sites/codesnippets/getstarted.qmd
- text: "Webservices"
href: sites/webservices.qmd
- text: "Styleguide"
href: sites/styleguide.qmd
- section: "Webservices"
href: sites/webservices.qmd
contents:
- layout.qmd
- layout-knitr.qmd
- layout-jupyter.qmd
- text: "Getting Started"
href: sites/getstarted.qmd
page-footer:
left: "Copyright 2025, Simeon Wallrath"
right:
- icon: github
href: https://github.com/
- icon: mastodon
href: https://twitter.com/
href: https://mastodon.gamedev.place/@sciencedev

58
_site/about.html
View file

@ -38,7 +38,7 @@ ul.task-list li input[type="checkbox"] {
<link href="site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
@ -127,40 +127,54 @@ ul.task-list li input[type="checkbox"] {
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/overview.html" class="sidebar-item-text sidebar-link">
<a href="./index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="./sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout.qmd</span>
<div class="sidebar-item-container">
<a href="./sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout-knitr.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-jupyter.qmd</span>
</li>
<div class="sidebar-item-container">
<a href="./sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Getting Started</span></a>
<a href="./sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
</ul>
@ -627,13 +641,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) {
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://github.com/">
<i class="bi bi-github" role="img">
</i>
</a>
</li>
<li class="nav-item compact">
<a class="nav-link" href="https://twitter.com/">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>

111
_site/index.html
View file

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>Home – DOCUMENTATION</title>
<title>Overview – DOCUMENTATION</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
@ -38,7 +38,7 @@ ul.task-list li input[type="checkbox"] {
<link href="site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
@ -105,7 +105,7 @@ ul.task-list li input[type="checkbox"] {
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item">Home</li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./index.html">Overview</a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
@ -127,65 +127,70 @@ ul.task-list li input[type="checkbox"] {
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/overview.html" class="sidebar-item-text sidebar-link">
<a href="./index.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="./sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-knitr.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-jupyter.qmd</span>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Getting Started</span></a>
</div>
</li>
</ul>
</div>
</nav>
<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">On this page</h2>
<ul>
<li><a href="#welcome-to-the-documentation" id="toc-welcome-to-the-documentation" class="nav-link active" data-scroll-target="#welcome-to-the-documentation">Welcome to the Documentation!</a>
<ul class="collapse">
<li><a href="#features" id="toc-features" class="nav-link" data-scroll-target="#features">Features</a></li>
</ul></li>
</ul>
</nav>
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar zindex-bottom">
</div>
<!-- main -->
<main class="content" id="quarto-document-content">
<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title">Home</h1>
<h1 class="title">Overview</h1>
</div>
@ -202,21 +207,9 @@ ul.task-list li input[type="checkbox"] {
</header>
<section id="welcome-to-the-documentation" class="level1">
<h1>Welcome to the Documentation!</h1>
<p>This is the main page of your documentation. You can add more sections or documentation as you need.</p>
<section id="features" class="level2">
<h2 class="anchored" data-anchor-id="features">Features</h2>
<ul>
<li>Easy setup</li>
<li>User-friendly interface</li>
<li>Rich documentation</li>
</ul>
<p>For more details, refer to the Getting Started section in the sidebar.</p>
<p>This is the documentation for VIRTUOS WORLD.</p>
</section>
</section>
</main> <!-- /main -->
<script id="quarto-html-after-body" type="application/javascript">
@ -648,13 +641,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) {
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://github.com/">
<i class="bi bi-github" role="img">
</i>
</a>
</li>
<li class="nav-item compact">
<a class="nav-link" href="https://twitter.com/">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>

44
_site/search.json
View file

@ -103,26 +103,20 @@
"href": "sites/overview.html",
"title": "About",
"section": "",
"text": "About this site",
"text": "About this site"
},
{
"objectID": "sites/codesnippets/getstarted.html",
"href": "sites/codesnippets/getstarted.html",
"title": "Code",
"section": "",
"text": "Example for BlueprintUE",
"crumbs": [
"Homepage",
"Overview"
"Code Snippets",
"Code"
]
},
{
"objectID": "index.html",
"href": "index.html",
"title": "Home",
"section": "",
"text": "This is the main page of your documentation. You can add more sections or documentation as you need.\n\n\n\nEasy setup\nUser-friendly interface\nRich documentation\n\nFor more details, refer to the Getting Started section in the sidebar."
},
{
"objectID": "index.html#features",
"href": "index.html#features",
"title": "Home",
"section": "",
"text": "Easy setup\nUser-friendly interface\nRich documentation\n\nFor more details, refer to the Getting Started section in the sidebar."
},
{
"objectID": "about.html",
"href": "about.html",
@ -130,15 +124,27 @@
"section": "",
"text": "About this site"
},
{
"objectID": "index.html",
"href": "index.html",
"title": "Overview",
"section": "",
"text": "This is the documentation for VIRTUOS WORLD.",
"crumbs": [
"Homepage",
"Overview"
]
},
{
"objectID": "sites/getstarted.html",
"href": "sites/getstarted.html",
"title": "Getting Started",
"title": "Project Setup",
"section": "",
"text": "If you want to take a look inside a project, there are currently three important repositories:\n\nVIRTUOS_Playground: The repository contains the Unreal Engine Project\nVIRTUOS_Assets: Contains all Project related assets like 3D-Models, Graphics etc.\nVIRTUOS_Documents: Contains all written Documents\n\n\nSetting up the project with UE5\nIf you’re familiar with Git, you’ll likely already know how to get the files.\ngit pull https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Docs.git\nIf you’re not comforatable with the command line, you can install a Git GUI like Github Desktop.",
"crumbs": [
"Homepage",
"Getting Started"
"Getting Started",
"Project Setup"
]
},
{
@ -146,7 +152,7 @@
"href": "sites/styleguide.html",
"title": "Styleguide",
"section": "",
"text": "This Styleguiade is adapted by Gamemakin UE5 Styleguide.",
"text": "This Styleguide is adapted by Gamemakin UE5 Styleguide.",
"crumbs": [
"Homepage",
"Styleguide"

2
_site/site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css → _site/site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css vendored
View file

File diff suppressed because one or more lines are too long

658
_site/sites/codesnippets/getstarted.html Normal file
View file

@ -0,0 +1,658 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.6.43">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>Code – DOCUMENTATION</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
</style>
<script src="../../site_libs/quarto-nav/quarto-nav.js"></script>
<script src="../../site_libs/quarto-nav/headroom.min.js"></script>
<script src="../../site_libs/clipboard/clipboard.min.js"></script>
<script src="../../site_libs/quarto-search/autocomplete.umd.js"></script>
<script src="../../site_libs/quarto-search/fuse.min.js"></script>
<script src="../../site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="../../">
<script src="../../site_libs/quarto-html/quarto.js"></script>
<script src="../../site_libs/quarto-html/popper.min.js"></script>
<script src="../../site_libs/quarto-html/tippy.umd.min.js"></script>
<script src="../../site_libs/quarto-html/anchor.min.js"></script>
<link href="../../site_libs/quarto-html/tippy.css" rel="stylesheet">
<link href="../../site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../../site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
"collapse-after": 3,
"panel-placement": "end",
"type": "overlay",
"limit": 50,
"keyboard-shortcut": [
"f",
"/",
"s"
],
"show-item-context": false,
"language": {
"search-no-results-text": "No results",
"search-matching-documents-text": "matching documents",
"search-copy-link-title": "Copy link to search",
"search-hide-matches-text": "Hide additional matches",
"search-more-match-text": "more match in this document",
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-text-placeholder": "",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
}
}</script>
</head>
<body class="nav-sidebar docked nav-fixed">
<div id="quarto-search-results"></div>
<header id="quarto-header" class="headroom fixed-top">
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
<div class="navbar-container container-fluid">
<div class="navbar-brand-container mx-auto">
<a href="../../index.html" class="navbar-brand navbar-brand-logo">
<img src="../../img/Logo.png" alt="" class="navbar-logo">
</a>
<a class="navbar-brand" href="../../index.html">
<span class="navbar-title">DOCUMENTATION</span>
</a>
</div>
<div id="quarto-search" class="" title="Search"></div>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarCollapse">
<ul class="navbar-nav navbar-nav-scroll me-auto">
<li class="nav-item">
<a class="nav-link" href="https://virtuos.world">
<span class="menu-text">Homepage</span></a>
</li>
</ul>
</div> <!-- /navcollapse -->
<div class="quarto-navbar-tools">
</div>
</div> <!-- /container-fluid -->
</nav>
<nav class="quarto-secondary-nav">
<div class="container-fluid d-flex">
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../sites/codesnippets/getstarted.html">Code Snippets</a></li><li class="breadcrumb-item"><a href="../../sites/codesnippets/getstarted.html">Code</a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
<i class="bi bi-search"></i>
</button>
</div>
</nav>
</header>
<!-- content -->
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
<!-- sidebar -->
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation docked overflow-auto">
<div class="mt-2 flex-shrink-0 align-items-center">
<div class="sidebar-search">
<div id="quarto-search" class="" title="Search"></div>
</div>
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
</ul>
</div>
</nav>
<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar zindex-bottom">
</div>
<!-- main -->
<main class="content" id="quarto-document-content">
<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../sites/codesnippets/getstarted.html">Code Snippets</a></li><li class="breadcrumb-item"><a href="../../sites/codesnippets/getstarted.html">Code</a></li></ol></nav>
<div class="quarto-title">
<h1 class="title">Code</h1>
</div>
<div class="quarto-title-meta">
</div>
</header>
<p>Example for BlueprintUE</p>
<iframe width="100%" height="500" src="https://blueprintue.com/render/-azlwrm2/" scrolling="no" allowfullscreen=""></iframe>
</main> <!-- /main -->
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const toggleBodyColorMode = (bsSheetEl) => {
const mode = bsSheetEl.getAttribute("data-mode");
const bodyEl = window.document.querySelector("body");
if (mode === "dark") {
bodyEl.classList.add("quarto-dark");
bodyEl.classList.remove("quarto-light");
} else {
bodyEl.classList.add("quarto-light");
bodyEl.classList.remove("quarto-dark");
}
}
const toggleBodyColorPrimary = () => {
const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");
if (bsSheetEl) {
toggleBodyColorMode(bsSheetEl);
}
}
toggleBodyColorPrimary();
const icon = "";
const anchorJS = new window.AnchorJS();
anchorJS.options = {
placement: 'right',
icon: icon
};
anchorJS.add('.anchored');
const isCodeAnnotation = (el) => {
for (const clz of el.classList) {
if (clz.startsWith('code-annotation-')) {
return true;
}
}
return false;
}
const onCopySuccess = function(e) {
// button target
const button = e.trigger;
// don't keep focus
button.blur();
// flash "checked"
button.classList.add('code-copy-button-checked');
var currentTitle = button.getAttribute("title");
button.setAttribute("title", "Copied!");
let tooltip;
if (window.bootstrap) {
button.setAttribute("data-bs-toggle", "tooltip");
button.setAttribute("data-bs-placement", "left");
button.setAttribute("data-bs-title", "Copied!");
tooltip = new bootstrap.Tooltip(button,
{ trigger: "manual",
customClass: "code-copy-button-tooltip",
offset: [0, -8]});
tooltip.show();
}
setTimeout(function() {
if (tooltip) {
tooltip.hide();
button.removeAttribute("data-bs-title");
button.removeAttribute("data-bs-toggle");
button.removeAttribute("data-bs-placement");
}
button.setAttribute("title", currentTitle);
button.classList.remove('code-copy-button-checked');
}, 1000);
// clear code selection
e.clearSelection();
}
const getTextToCopy = function(trigger) {
const codeEl = trigger.previousElementSibling.cloneNode(true);
for (const childEl of codeEl.children) {
if (isCodeAnnotation(childEl)) {
childEl.remove();
}
}
return codeEl.innerText;
}
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
text: getTextToCopy
});
clipboard.on('success', onCopySuccess);
if (window.document.getElementById('quarto-embedded-source-code-modal')) {
const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
text: getTextToCopy,
container: window.document.getElementById('quarto-embedded-source-code-modal')
});
clipboardModal.on('success', onCopySuccess);
}
var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
var mailtoRegex = new RegExp(/^mailto:/);
var filterRegex = new RegExp('/' + window.location.host + '/');
var isInternal = (href) => {
return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
}
// Inspect non-navigation links and adorn them if external
var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
for (var i=0; i<links.length; i++) {
const link = links[i];
if (!isInternal(link.href)) {
// undo the damage that might have been done by quarto-nav.js in the case of
// links that we want to consider external
if (link.dataset.originalHref !== undefined) {
link.href = link.dataset.originalHref;
}
}
}
function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
const config = {
allowHTML: true,
maxWidth: 500,
delay: 100,
arrow: false,
appendTo: function(el) {
return el.parentElement;
},
interactive: true,
interactiveBorder: 10,
theme: 'quarto',
placement: 'bottom-start',
};
if (contentFn) {
config.content = contentFn;
}
if (onTriggerFn) {
config.onTrigger = onTriggerFn;
}
if (onUntriggerFn) {
config.onUntrigger = onUntriggerFn;
}
window.tippy(el, config);
}
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
for (var i=0; i<noterefs.length; i++) {
const ref = noterefs[i];
tippyHover(ref, function() {
// use id or data attribute instead here
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
try { href = new URL(href).hash; } catch {}
const id = href.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note) {
return note.innerHTML;
} else {
return "";
}
});
}
const xrefs = window.document.querySelectorAll('a.quarto-xref');
const processXRef = (id, note) => {
// Strip column container classes
const stripColumnClz = (el) => {
el.classList.remove("page-full", "page-columns");
if (el.children) {
for (const child of el.children) {
stripColumnClz(child);
}
}
}
stripColumnClz(note)
if (id === null || id.startsWith('sec-')) {
// Special case sections, only their first couple elements
const container = document.createElement("div");
if (note.children && note.children.length > 2) {
container.appendChild(note.children[0].cloneNode(true));
for (let i = 1; i < note.children.length; i++) {
const child = note.children[i];
if (child.tagName === "P" && child.innerText === "") {
continue;
} else {
container.appendChild(child.cloneNode(true));
break;
}
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(container);
}
return container.innerHTML
} else {
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
return note.innerHTML;
}
} else {
// Remove any anchor links if they are present
const anchorLink = note.querySelector('a.anchorjs-link');
if (anchorLink) {
anchorLink.remove();
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
if (note.classList.contains("callout")) {
return note.outerHTML;
} else {
return note.innerHTML;
}
}
}
for (var i=0; i<xrefs.length; i++) {
const xref = xrefs[i];
tippyHover(xref, undefined, function(instance) {
instance.disable();
let url = xref.getAttribute('href');
let hash = undefined;
if (url.startsWith('#')) {
hash = url;
} else {
try { hash = new URL(url).hash; } catch {}
}
if (hash) {
const id = hash.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note !== null) {
try {
const html = processXRef(id, note.cloneNode(true));
instance.setContent(html);
} finally {
instance.enable();
instance.show();
}
} else {
// See if we can fetch this
fetch(url.split('#')[0])
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.getElementById(id);
if (note !== null) {
const html = processXRef(id, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
} else {
// See if we can fetch a full url (with no hash to target)
// This is a special case and we should probably do some content thinning / targeting
fetch(url)
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.querySelector('main.content');
if (note !== null) {
// This should only happen for chapter cross references
// (since there is no id in the URL)
// remove the first header
if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
note.children[0].remove();
}
const html = processXRef(null, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
}, function(instance) {
});
}
let selectedAnnoteEl;
const selectorForAnnotation = ( cell, annotation) => {
let cellAttr = 'data-code-cell="' + cell + '"';
let lineAttr = 'data-code-annotation="' + annotation + '"';
const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
return selector;
}
const selectCodeLines = (annoteEl) => {
const doc = window.document;
const targetCell = annoteEl.getAttribute("data-target-cell");
const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
const lines = annoteSpan.getAttribute("data-code-lines").split(",");
const lineIds = lines.map((line) => {
return targetCell + "-" + line;
})
let top = null;
let height = null;
let parent = null;
if (lineIds.length > 0) {
//compute the position of the single el (top and bottom and make a div)
const el = window.document.getElementById(lineIds[0]);
top = el.offsetTop;
height = el.offsetHeight;
parent = el.parentElement.parentElement;
if (lineIds.length > 1) {
const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
const bottom = lastEl.offsetTop + lastEl.offsetHeight;
height = bottom - top;
}
if (top !== null && height !== null && parent !== null) {
// cook up a div (if necessary) and position it
let div = window.document.getElementById("code-annotation-line-highlight");
if (div === null) {
div = window.document.createElement("div");
div.setAttribute("id", "code-annotation-line-highlight");
div.style.position = 'absolute';
parent.appendChild(div);
}
div.style.top = top - 2 + "px";
div.style.height = height + 4 + "px";
div.style.left = 0;
let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
if (gutterDiv === null) {
gutterDiv = window.document.createElement("div");
gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
gutterDiv.style.position = 'absolute';
const codeCell = window.document.getElementById(targetCell);
const gutter = codeCell.querySelector('.code-annotation-gutter');
gutter.appendChild(gutterDiv);
}
gutterDiv.style.top = top - 2 + "px";
gutterDiv.style.height = height + 4 + "px";
}
selectedAnnoteEl = annoteEl;
}
};
const unselectCodeLines = () => {
const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
elementsIds.forEach((elId) => {
const div = window.document.getElementById(elId);
if (div) {
div.remove();
}
});
selectedAnnoteEl = undefined;
};
// Handle positioning of the toggle
window.addEventListener(
"resize",
throttle(() => {
elRect = undefined;
if (selectedAnnoteEl) {
selectCodeLines(selectedAnnoteEl);
}
}, 10)
);
function throttle(fn, ms) {
let throttle = false;
let timer;
return (...args) => {
if(!throttle) { // first call gets through
fn.apply(this, args);
throttle = true;
} else { // all the others get throttled
if(timer) clearTimeout(timer); // cancel #2
timer = setTimeout(() => {
fn.apply(this, args);
timer = throttle = false;
}, ms);
}
};
}
// Attach click handler to the DT
const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
for (const annoteDlNode of annoteDls) {
annoteDlNode.addEventListener('click', (event) => {
const clickedEl = event.target;
if (clickedEl !== selectedAnnoteEl) {
unselectCodeLines();
const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
if (activeEl) {
activeEl.classList.remove('code-annotation-active');
}
selectCodeLines(clickedEl);
clickedEl.classList.add('code-annotation-active');
} else {
// Unselect the line
unselectCodeLines();
clickedEl.classList.remove('code-annotation-active');
}
});
}
const findCites = (el) => {
const parentEl = el.parentElement;
if (parentEl) {
const cites = parentEl.dataset.cites;
if (cites) {
return {
el,
cites: cites.split(' ')
};
} else {
return findCites(el.parentElement)
}
} else {
return undefined;
}
};
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
for (var i=0; i<bibliorefs.length; i++) {
const ref = bibliorefs[i];
const citeInfo = findCites(ref);
if (citeInfo) {
tippyHover(citeInfo.el, function() {
var popup = window.document.createElement('div');
citeInfo.cites.forEach(function(cite) {
var citeDiv = window.document.createElement('div');
citeDiv.classList.add('hanging-indent');
citeDiv.classList.add('csl-entry');
var biblioDiv = window.document.getElementById('ref-' + cite);
if (biblioDiv) {
citeDiv.innerHTML = biblioDiv.innerHTML;
}
popup.appendChild(citeDiv);
});
return popup.innerHTML;
});
}
}
});
</script>
</div> <!-- /content -->
<footer class="footer">
<div class="nav-footer">
<div class="nav-footer-left">
<p>Copyright 2025, Simeon Wallrath</p>
</div>
<div class="nav-footer-center">
&nbsp;
</div>
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>
</li>
</ul>
</div>
</div>
</footer>
</body></html>

67
_site/sites/getstarted.html
View file

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>Getting Started – DOCUMENTATION</title>
<title>Project Setup – DOCUMENTATION</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
@ -72,7 +72,7 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
@ -139,7 +139,7 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../sites/getstarted.html">Getting Started</a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../sites/getstarted.html">Getting Started</a></li><li class="breadcrumb-item"><a href="../sites/getstarted.html">Project Setup</a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
@ -161,40 +161,54 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/overview.html" class="sidebar-item-text sidebar-link">
<a href="../index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout.qmd</span>
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout-knitr.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-jupyter.qmd</span>
</li>
<div class="sidebar-item-container">
<a href="../sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Getting Started</span></a>
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
</ul>
@ -214,9 +228,9 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<!-- main -->
<main class="content" id="quarto-document-content">
<header id="title-block-header" class="quarto-title-block default">
<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../sites/getstarted.html">Getting Started</a></li><li class="breadcrumb-item"><a href="../sites/getstarted.html">Project Setup</a></li></ol></nav>
<div class="quarto-title">
<h1 class="title">Getting Started</h1>
<h1 class="title">Project Setup</h1>
</div>
@ -244,7 +258,6 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<p>If you’re familiar with Git, you’ll likely already know how to get the files.</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> pull https://code.virtuos.world/VIRTUOS_WORLD/VIRTUOS_Docs.git</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>If you’re not comforatable with the command line, you can install a Git GUI like Github Desktop.</p>
<iframe width="100%" height="500" src="https://blueprintue.com/render/-azlwrm2/" scrolling="no" allowfullscreen=""></iframe>
</section>
@ -679,13 +692,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) {
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://github.com/">
<i class="bi bi-github" role="img">
</i>
</a>
</li>
<li class="nav-item compact">
<a class="nav-link" href="https://twitter.com/">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>

60
_site/sites/overview.html
View file

@ -38,7 +38,7 @@ ul.task-list li input[type="checkbox"] {
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
@ -105,7 +105,7 @@ ul.task-list li input[type="checkbox"] {
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../sites/overview.html">Overview</a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item">About</li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
@ -127,40 +127,54 @@ ul.task-list li input[type="checkbox"] {
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/overview.html" class="sidebar-item-text sidebar-link active">
<a href="../index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout.qmd</span>
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout-knitr.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-jupyter.qmd</span>
</li>
<div class="sidebar-item-container">
<a href="../sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Getting Started</span></a>
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
</ul>
@ -627,13 +641,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) {
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://github.com/">
<i class="bi bi-github" role="img">
</i>
</a>
</li>
<li class="nav-item compact">
<a class="nav-link" href="https://twitter.com/">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>

60
_site/sites/styleguide.html
View file

@ -38,7 +38,7 @@ ul.task-list li input[type="checkbox"] {
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
@ -127,40 +127,54 @@ ul.task-list li input[type="checkbox"] {
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/overview.html" class="sidebar-item-text sidebar-link">
<a href="../index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout.qmd</span>
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout-knitr.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-jupyter.qmd</span>
</li>
<div class="sidebar-item-container">
<a href="../sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Getting Started</span></a>
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
</ul>
@ -278,7 +292,7 @@ ul.task-list li input[type="checkbox"] {
</header>
<p>This Styleguiade is adapted by Gamemakin UE5 Styleguide.</p>
<p>This Styleguide is adapted by Gamemakin UE5 Styleguide.</p>
<section id="important-terminology" class="level2">
<h2 class="anchored" data-anchor-id="important-terminology">Important Terminology</h2>
<p><a name="terms-level-map"></a></p>
@ -2858,13 +2872,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) {
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://github.com/">
<i class="bi bi-github" role="img">
</i>
</a>
</li>
<li class="nav-item compact">
<a class="nav-link" href="https://twitter.com/">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>

58
_site/sites/webservices.html
View file

@ -72,7 +72,7 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-d4d76bf8491c20bad77d141916dc28e1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap-094cba0c3ec2ec168ef50fc8ee46e762.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-0b62b3ae9f91ee9cb3e3735b19b48bef.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "navbar",
"copy-button": false,
@ -161,40 +161,54 @@ pre > code.sourceCode > span > a:first-child::before { text-decoration: underlin
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/overview.html" class="sidebar-item-text sidebar-link">
<a href="../index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Overview</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Webservices</span></a>
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
<span class="menu-text">Getting Started</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout.qmd</span>
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Project Setup</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
<span class="menu-text">Code Snippets</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<span class="menu-text">layout-knitr.qmd</span>
</li>
<li class="sidebar-item">
<span class="menu-text">layout-jupyter.qmd</span>
</li>
<div class="sidebar-item-container">
<a href="../sites/codesnippets/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Code</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/getstarted.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Getting Started</span></a>
<a href="../sites/webservices.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Webservices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../sites/styleguide.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Styleguide</span></a>
</div>
</li>
</ul>
@ -962,13 +976,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) {
<div class="nav-footer-right">
<ul class="footer-items list-unstyled">
<li class="nav-item compact">
<a class="nav-link" href="https://github.com/">
<i class="bi bi-github" role="img">
</i>
</a>
</li>
<li class="nav-item compact">
<a class="nav-link" href="https://twitter.com/">
<a class="nav-link" href="https://mastodon.gamedev.place/@sciencedev">
<i class="bi bi-mastodon" role="img">
</i>
</a>

14
index.qmd
View file

@ -1,16 +1,6 @@
---
title: "Home"
title: "Overview"
---
# Welcome to the Documentation!
This is the main page of your documentation. You can add more sections or documentation as you need.
## Features
- Easy setup
- User-friendly interface
- Rich documentation
For more details, refer to the Getting Started section in the sidebar.
This is the documentation for VIRTUOS WORLD.

8
sites/codesnippets/getstarted.qmd Normal file
View file

@ -0,0 +1,8 @@
---
title: "Code"
---
Example for BlueprintUE
```{=html}
<iframe width="100%" height="500" src="https://blueprintue.com/render/-azlwrm2/" scrolling="no" allowfullscreen></iframe>
```

6
sites/getstarted.qmd
View file

@ -1,5 +1,5 @@
---
title: "Getting Started"
title: "Project Setup"
---
If you want to take a look inside a project, there are currently three important repositories:
@ -17,7 +17,3 @@ 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.
```{=html}
<iframe width="100%" height="500" src="https://blueprintue.com/render/-azlwrm2/" scrolling="no" allowfullscreen></iframe>
```

31
sites/styleguide.aux
View file

@ -1,31 +0,0 @@
\relax
\providecommand*\new@tpo@label[2]{}
\providecommand\hyper@newdestlabel[2]{}
\providecommand*\HyPL@Entry[1]{}
\HyPL@Entry{0<</S/D>>}
\@writefile{toc}{\contentsline {subsection}{\nonumberline Important Terminology}{1}{subsection*.2}\protected@file@percent }
\newlabel{important-terminology}{{}{1}{Important Terminology}{subsection*.2}{}}
\@writefile{toc}{\contentsline {subparagraph}{\nonumberline Levels/Maps}{1}{subparagraph*.4}\protected@file@percent }
\newlabel{levelsmaps}{{}{1}{Levels/Maps}{subparagraph*.4}{}}
\@writefile{toc}{\contentsline {subparagraph}{\nonumberline Identifiers}{1}{subparagraph*.6}\protected@file@percent }
\newlabel{identifiers}{{}{1}{Identifiers}{subparagraph*.6}{}}
\@writefile{toc}{\contentsline {subparagraph}{\nonumberline Cases}{1}{subparagraph*.8}\protected@file@percent }
\newlabel{cases}{{}{1}{Cases}{subparagraph*.8}{}}
\@writefile{toc}{\contentsline {subparagraph}{\nonumberline Variables / Properties}{2}{subparagraph*.10}\protected@file@percent }
\newlabel{variables-properties}{{}{2}{Variables / Properties}{subparagraph*.10}{}}
\@writefile{toc}{\contentsline {subsection}{\nonumberline 0. Principles}{2}{subsection*.12}\protected@file@percent }
\newlabel{principles}{{}{2}{0. Principles}{subsection*.12}{}}
\@writefile{toc}{\contentsline {subsubsection}{\nonumberline 0.1 If your UE4 project already has a style guide, you should follow it.}{3}{subsubsection*.14}\protected@file@percent }
\newlabel{if-your-ue4-project-already-has-a-style-guide-you-should-follow-it.}{{}{3}{0.1 If your UE4 project already has a style guide, you should follow it}{subsubsection*.14}{}}
\@writefile{toc}{\contentsline {paragraph}{\nonumberline ``Arguments over style are pointless. There should be a style guide, and you should follow it.''}{3}{paragraph*.16}\protected@file@percent }
\newlabel{arguments-over-style-are-pointless.-there-should-be-a-style-guide-and-you-should-follow-it.}{{}{3}{``Arguments over style are pointless. There should be a style guide, and you should follow it.''}{paragraph*.16}{}}
\@writefile{toc}{\contentsline {subsubsection}{\nonumberline 0.2 All structure, assets, and code in any Unreal Engine 4 project should look like a single person created it, no matter how many people contributed.}{3}{subsubsection*.18}\protected@file@percent }
\newlabel{all-structure-assets-and-code-in-any-unreal-engine-4-project-should-look-like-a-single-person-created-it-no-matter-how-many-people-contributed.}{{}{3}{0.2 All structure, assets, and code in any Unreal Engine 4 project should look like a single person created it, no matter how many people contributed}{subsubsection*.18}{}}
\@writefile{toc}{\contentsline {subsubsection}{\nonumberline 0.3 Friends do not let friends have bad style.}{3}{subsubsection*.20}\protected@file@percent }
\newlabel{friends-do-not-let-friends-have-bad-style.}{{}{3}{0.3 Friends do not let friends have bad style}{subsubsection*.20}{}}
\@writefile{toc}{\contentsline {subsubsection}{\nonumberline 0.4 A team without a style guide is no team of mine.}{4}{subsubsection*.22}\protected@file@percent }
\newlabel{a-team-without-a-style-guide-is-no-team-of-mine.}{{}{4}{0.4 A team without a style guide is no team of mine}{subsubsection*.22}{}}
\@writefile{toc}{\contentsline {subsubsection}{\nonumberline 0.5 Don't Break The Law}{4}{subsubsection*.24}\protected@file@percent }
\newlabel{dont-break-the-law}{{}{4}{0.5 Don't Break The Law}{subsubsection*.24}{}}
\@writefile{toc}{\contentsline {subsection}{\nonumberline 00. Globally Enforced Opinions}{4}{subsection*.26}\protected@file@percent }
\newlabel{globally-enforced-opinions}{{}{4}{00. Globally Enforced Opinions}{subsection*.26}{}}

1125
sites/styleguide.log
View file

File diff suppressed because it is too large Load diff

BIN
sites/styleguide.pdf
View file

Binary file not shown.

2
sites/styleguide.qmd
View file

@ -1,7 +1,7 @@
---
title: "Styleguide"
---
This Styleguiade is adapted by Gamemakin UE5 Styleguide.
This Styleguide is adapted by Gamemakin UE5 Styleguide.
## Important Terminology

2397
sites/styleguide.tex
View file

File diff suppressed because it is too large Load diff

45
theme.scss
View file

@ -7,18 +7,32 @@ $primary: #009fe3;
/*-- scss:rules --*/
/* Add custom rules for sidebar items and sections */
.sidebar-item-text, .sidebar-item-toggle {
padding-top: 20px; /* Optional: spacing between items */
}
.sidebar-item-text:last-child {
border-bottom: none;
}
.sidebar-item-text:not(:first-child) {
margin-top: 10px; /* Add space above each *non-first* section */
/* Top-level items: bold and with padding */
.sidebar-menu-container > ul > li.sidebar-item > .sidebar-item-container > a.sidebar-item-text {
font-weight: bold;
padding-top: 20px;
display: block;
}
/* Subitems: normal weight and no bold */
.sidebar-menu-container .sidebar-section .sidebar-item-text {
font-weight: normal;
}
/* Align and apply padding to .sidebar-item-toggle arrows to match subitems */
.sidebar-menu-container .sidebar-item-toggle {
font-weight: normal; /* Ensure arrow is not bold */
padding-top: 20px; /* Match top-level padding */
display: inline-block; /* Ensure proper alignment */
margin-left: 15px; /* Optional: indent to align with subitems */
}
/* Optional: additional spacing for non-first items */
.sidebar-menu-container > ul > li.sidebar-item:not(:first-child) > .sidebar-item-container > a.sidebar-item-text {
margin-top: 10px;
padding-top: 10px;
}
}
.sidebar-menu-container, .mt-2 {
@ -26,6 +40,15 @@ $primary: #009fe3;
padding-top: 0 !important;
}
.quarto-sidebar-section-1 {
padding-top: 2px
}
.sidebar-section .sidebar-item-text {
font-weight: normal;
}
.navbar-logo{
margin: 0 !important;
padding: 0 !important;