2025-04-07 20:33:27 +02:00
<!DOCTYPE html>
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en" xml:lang = "en" > < head >
< meta charset = "utf-8" >
2025-08-19 11:46:30 +02:00
< meta name = "generator" content = "quarto-1.7.33" >
2025-04-07 20:33:27 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0, user-scalable=yes" >
2025-04-16 09:35:03 +02:00
< title > Project Setup – < / title >
2025-04-07 20:33:27 +02:00
< 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;
}
/* CSS for syntax highlighting */
2025-08-19 11:46:30 +02:00
html { -webkit-text-size-adjust: 100%; }
2025-04-07 20:33:27 +02:00
pre > code.sourceCode { white-space: pre; position: relative; }
2025-08-19 11:46:30 +02:00
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
2025-04-07 20:33:27 +02:00
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
2025-08-19 11:46:30 +02:00
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
2025-04-07 20:33:27 +02:00
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
}
pre.numberSource { margin-left: 3em; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
< / 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 = "../" >
2025-08-19 11:46:30 +02:00
< script src = "../site_libs/quarto-html/quarto.js" type = "module" > < / script >
< script src = "../site_libs/quarto-html/tabsets/tabsets.js" type = "module" > < / script >
2025-04-07 20:33:27 +02:00
< 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" >
2025-08-19 11:46:30 +02:00
< link href = "../site_libs/quarto-html/quarto-syntax-highlighting-ea385d0e468b0dd5ea5bf0780b1290d9.css" rel = "stylesheet" class = "quarto-color-scheme" id = "quarto-text-highlighting-styles" >
< link href = "../site_libs/quarto-html/quarto-syntax-highlighting-dark-bc185b5c5bdbcb35c2eb49d8a876ef70.css" rel = "stylesheet" class = "quarto-color-scheme quarto-color-alternate" id = "quarto-text-highlighting-styles" >
2025-04-07 20:33:27 +02:00
< script src = "../site_libs/bootstrap/bootstrap.min.js" > < / script >
< link href = "../site_libs/bootstrap/bootstrap-icons.css" rel = "stylesheet" >
2025-08-19 11:46:30 +02:00
< link href = "../site_libs/bootstrap/bootstrap-32fa625705450195742079e70094aa8d.min.css" rel = "stylesheet" append-hash = "true" class = "quarto-color-scheme" id = "quarto-bootstrap" data-mode = "light" >
< link href = "../site_libs/bootstrap/bootstrap-dark-b23b6ab41e2233570f882a9525eb7ac9.min.css" rel = "stylesheet" append-hash = "true" class = "quarto-color-scheme quarto-color-alternate" id = "quarto-bootstrap" data-mode = "dark" >
2025-04-07 20:33:27 +02:00
< 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 >
2025-08-19 11:46:30 +02:00
< body class = "nav-sidebar docked nav-fixed quarto-dark" > < script id = "quarto-html-before-body" type = "application/javascript" >
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:not([rel=disabled-stylesheet])");
if (bsSheetEl) {
toggleBodyColorMode(bsSheetEl);
}
}
const setColorSchemeToggle = (alternate) => {
const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
for (let i=0; i < toggles.length ; i + + ) {
const toggle = toggles[i];
if (toggle) {
if (alternate) {
toggle.classList.add("alternate");
} else {
toggle.classList.remove("alternate");
}
}
}
};
const toggleColorMode = (alternate) => {
// Switch the stylesheets
const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
manageTransitions('#quarto-margin-sidebar .nav-link', false);
if (alternate) {
// note: dark is layered on light, we don't disable primary!
enableStylesheet(alternateStylesheets);
for (const sheetNode of alternateStylesheets) {
if (sheetNode.id === "quarto-bootstrap") {
toggleBodyColorMode(sheetNode);
}
}
} else {
disableStylesheet(alternateStylesheets);
enableStylesheet(primaryStylesheets)
toggleBodyColorPrimary();
}
manageTransitions('#quarto-margin-sidebar .nav-link', true);
// Switch the toggles
setColorSchemeToggle(alternate)
// Hack to workaround the fact that safari doesn't
// properly recolor the scrollbar when toggling (#1455)
if (navigator.userAgent.indexOf('Safari') > 0 & & navigator.userAgent.indexOf('Chrome') == -1) {
manageTransitions("body", false);
window.scrollTo(0, 1);
setTimeout(() => {
window.scrollTo(0, 0);
manageTransitions("body", true);
}, 40);
}
}
const disableStylesheet = (stylesheets) => {
for (let i=0; i < style sheets . length ; i + + ) {
const stylesheet = stylesheets[i];
stylesheet.rel = 'disabled-stylesheet';
}
}
const enableStylesheet = (stylesheets) => {
for (let i=0; i < style sheets . length ; i + + ) {
const stylesheet = stylesheets[i];
if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
stylesheet.rel = 'stylesheet';
}
}
}
const manageTransitions = (selector, allowTransitions) => {
const els = window.document.querySelectorAll(selector);
for (let i=0; i < els.length ; i + + ) {
const el = els[i];
if (allowTransitions) {
el.classList.remove('notransition');
} else {
el.classList.add('notransition');
}
}
}
const isFileUrl = () => {
return window.location.protocol === 'file:';
}
const hasAlternateSentinel = () => {
let styleSentinel = getColorSchemeSentinel();
if (styleSentinel !== null) {
return styleSentinel === "alternate";
} else {
return false;
}
}
const setStyleSentinel = (alternate) => {
const value = alternate ? "alternate" : "default";
if (!isFileUrl()) {
window.localStorage.setItem("quarto-color-scheme", value);
} else {
localAlternateSentinel = value;
}
}
const getColorSchemeSentinel = () => {
if (!isFileUrl()) {
const storageValue = window.localStorage.getItem("quarto-color-scheme");
return storageValue != null ? storageValue : localAlternateSentinel;
} else {
return localAlternateSentinel;
}
}
const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
let newTheme = '';
if(authorPrefersDark) {
newTheme = isAlternate ? baseTheme : alternateTheme;
} else {
newTheme = isAlternate ? alternateTheme : baseTheme;
}
const changeGiscusTheme = () => {
// From: https://github.com/giscus/giscus/issues/336
const sendMessage = (message) => {
const iframe = document.querySelector('iframe.giscus-frame');
if (!iframe) return;
iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
}
sendMessage({
setConfig: {
theme: newTheme
}
});
}
const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
if (isGiscussLoaded) {
changeGiscusTheme();
}
};
const authorPrefersDark = true;
const darkModeDefault = authorPrefersDark;
let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
// Dark / light mode switch
window.quartoToggleColorScheme = () => {
// Read the current dark / light value
let toAlternate = !hasAlternateSentinel();
toggleColorMode(toAlternate);
setStyleSentinel(toAlternate);
toggleGiscusIfUsed(toAlternate, darkModeDefault);
window.dispatchEvent(new Event('resize'));
};
// Switch to dark mode if need be
if (hasAlternateSentinel()) {
toggleColorMode(true);
} else {
toggleColorMode(false);
}
< / script >
2025-04-07 20:33:27 +02:00
< 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" >
2025-04-08 09:51:23 +02:00
< a href = "../index.html" class = "navbar-brand navbar-brand-logo" >
< img src = "../img/Logo.png" alt = "" class = "navbar-logo" >
< / a >
2025-04-07 20:33:27 +02:00
< a class = "navbar-brand" href = "../index.html" >
2025-04-16 09:35:03 +02:00
< span class = "navbar-title" > Docs< / span >
2025-04-07 20:33:27 +02:00
< / 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" >
2025-04-16 09:35:03 +02:00
< a href = "" class = "quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick = "window.quartoToggleColorScheme(); return false;" title = "Toggle dark mode" > < i class = "bi" > < / i > < / a >
2025-04-07 20:33:27 +02:00
< / 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 >
2025-04-16 09:35:03 +02:00
< nav class = "quarto-page-breadcrumbs" aria-label = "breadcrumb" > < ol class = "breadcrumb" > < li class = "breadcrumb-item" > < a href = "../sites/getstarted.html" > Get Started< / a > < / li > < li class = "breadcrumb-item" > < a href = "../sites/getstarted.html" > Project Setup< / a > < / li > < / ol > < / nav >
2025-04-07 20:33:27 +02:00
< 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" >
2025-04-08 09:51:23 +02:00
< li class = "sidebar-item" >
< div class = "sidebar-item-container" >
2025-04-08 11:37:06 +02:00
< a href = "../index.html" class = "sidebar-item-text sidebar-link" >
2025-04-08 09:51:23 +02:00
< span class = "menu-text" > Overview< / span > < / a >
< / div >
< / li >
2025-04-07 20:33:27 +02:00
< li class = "sidebar-item sidebar-item-section" >
< div class = "sidebar-item-container" >
2025-04-08 11:37:06 +02:00
< 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" >
2025-04-16 09:35:03 +02:00
< span class = "menu-text" > Get Started< / span > < / a >
2025-04-08 09:51:23 +02:00
< 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" >
2025-04-07 20:33:27 +02:00
< i class = "bi bi-chevron-right ms-2" > < / i >
< / a >
< / div >
2025-04-08 09:51:23 +02:00
< ul id = "quarto-sidebar-section-1" class = "collapse list-unstyled sidebar-section depth1 show" >
2025-04-07 20:33:27 +02:00
< li class = "sidebar-item" >
2025-04-08 11:37:06 +02:00
< 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 >
2025-04-07 20:33:27 +02:00
< / li >
2025-04-08 11:37:06 +02:00
< 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" >
2025-04-07 20:33:27 +02:00
< li class = "sidebar-item" >
2025-04-08 11:37:06 +02:00
< 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 >
2025-04-07 20:33:27 +02:00
< / ul >
< / li >
2025-04-08 09:51:23 +02:00
< li class = "sidebar-item" >
< div class = "sidebar-item-container" >
2025-04-08 11:37:06 +02:00
< 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 >
2025-04-08 09:51:23 +02:00
< / div >
< / li >
2025-04-07 20:33:27 +02:00
< / 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 = "#setting-up-the-project-with-ue5" id = "toc-setting-up-the-project-with-ue5" class = "nav-link active" data-scroll-target = "#setting-up-the-project-with-ue5" > Setting up the project with UE5< / a > < / li >
< / ul >
< / nav >
< / div >
<!-- main -->
< main class = "content" id = "quarto-document-content" >
2025-08-19 11:46:30 +02:00
2025-04-16 09:35:03 +02:00
< 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" > Get Started< / a > < / li > < li class = "breadcrumb-item" > < a href = "../sites/getstarted.html" > Project Setup< / a > < / li > < / ol > < / nav >
2025-04-07 20:33:27 +02:00
< div class = "quarto-title" >
2025-04-08 11:37:06 +02:00
< h1 class = "title" > Project Setup< / h1 >
2025-04-07 20:33:27 +02:00
< / div >
< div class = "quarto-title-meta" >
< / div >
< / header >
< p > If you want to take a look inside a project, there are currently three important repositories:< / p >
< ul >
< li > VIRTUOS_Playground: The repository contains the Unreal Engine Project< / li >
< li > VIRTUOS_Assets: Contains all Project related assets like 3D-Models, Graphics etc.< / li >
< li > VIRTUOS_Documents: Contains all written Documents< / li >
< / ul >
< section id = "setting-up-the-project-with-ue5" class = "level1" >
< h1 > Setting up the project with UE5< / h1 >
< p > If you’ ’ < / 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’ < / p >
< / section >
< / main > <!-- /main -->
< script id = "quarto-html-after-body" type = "application/javascript" >
2025-08-19 11:46:30 +02:00
window.document.addEventListener("DOMContentLoaded", function (event) {
// Ensure there is a toggle, if there isn't float one in the top right
if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
const a = window.document.createElement('a');
a.classList.add('top-right');
a.classList.add('quarto-color-scheme-toggle');
a.href = "";
a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
const i = window.document.createElement("i");
i.classList.add('bi');
a.appendChild(i);
window.document.body.appendChild(a);
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
setColorSchemeToggle(hasAlternateSentinel())
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;
}
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
return false;
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
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();
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
setTimeout(function() {
if (tooltip) {
tooltip.hide();
button.removeAttribute("data-bs-title");
button.removeAttribute("data-bs-toggle");
button.removeAttribute("data-bs-placement");
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
button.setAttribute("title", currentTitle);
button.classList.remove('code-copy-button-checked');
}, 1000);
// clear code selection
e.clearSelection();
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
const getTextToCopy = function(trigger) {
const codeEl = trigger.previousElementSibling.cloneNode(true);
for (const childEl of codeEl.children) {
if (isCodeAnnotation(childEl)) {
childEl.remove();
}
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
return codeEl.innerText;
2025-04-16 09:35:03 +02:00
}
2025-08-19 11:46:30 +02:00
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;
}
2025-04-16 09:35:03 +02:00
}
}
2025-08-19 11:46:30 +02:00
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;
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
if (onTriggerFn) {
config.onTrigger = onTriggerFn;
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
if (onUntriggerFn) {
config.onUntrigger = onUntriggerFn;
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
window.tippy(el, config);
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
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 "";
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
});
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
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);
}
2025-04-07 20:33:27 +02:00
}
}
2025-08-19 11:46:30 +02:00
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;
}
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(container);
}
return container.innerHTML
} else {
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
return note.innerHTML;
2025-04-07 20:33:27 +02:00
}
} else {
2025-08-19 11:46:30 +02:00
// Remove any anchor links if they are present
const anchorLink = note.querySelector('a.anchorjs-link');
if (anchorLink) {
anchorLink.remove();
}
2025-04-07 20:33:27 +02:00
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
2025-08-19 11:46:30 +02:00
if (note.classList.contains("callout")) {
return note.outerHTML;
} else {
return note.innerHTML;
}
2025-04-07 20:33:27 +02:00
}
}
2025-08-19 11:46:30 +02:00
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();
});
2025-04-07 20:33:27 +02:00
}
} else {
2025-08-19 11:46:30 +02:00
// 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)
2025-04-07 20:33:27 +02:00
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
2025-08-19 11:46:30 +02:00
const note = htmlDoc.querySelector('main.content');
2025-04-07 20:33:27 +02:00
if (note !== null) {
2025-08-19 11:46:30 +02:00
// 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);
2025-04-07 20:33:27 +02:00
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
2025-08-19 11:46:30 +02:00
}, 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;
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
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";
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
selectedAnnoteEl = annoteEl;
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
};
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);
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
}, 10)
);
function throttle(fn, ms) {
let throttle = false;
let timer;
return (...args) => {
if(!throttle) { // first call gets through
2025-04-07 20:33:27 +02:00
fn.apply(this, args);
2025-08-19 11:46:30 +02:00
throttle = true;
} else { // all the others get throttled
if(timer) clearTimeout(timer); // cancel #2
timer = setTimeout(() => {
fn.apply(this, args);
timer = throttle = false;
}, ms);
2025-04-07 20:33:27 +02:00
}
};
2025-08-19 11:46:30 +02:00
}
// 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)
}
2025-04-07 20:33:27 +02:00
} else {
2025-08-19 11:46:30 +02:00
return undefined;
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
};
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;
2025-04-07 20:33:27 +02:00
});
2025-08-19 11:46:30 +02:00
}
2025-04-07 20:33:27 +02:00
}
2025-08-19 11:46:30 +02:00
});
< / script >
2025-04-07 20:33:27 +02:00
< / 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" >
< / div >
< div class = "nav-footer-right" >
< ul class = "footer-items list-unstyled" >
< li class = "nav-item compact" >
2025-04-08 11:37:06 +02:00
< a class = "nav-link" href = "https://mastodon.gamedev.place/@sciencedev" >
2025-04-07 20:33:27 +02:00
< i class = "bi bi-mastodon" role = "img" >
< / i >
< / a >
< / li >
< / ul >
< / div >
< / div >
< / footer >
< / body > < / html >
