24 lines
19 KiB
HTML
24 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Development Guide | micromissiles-unity</title>
|
||
<meta name="description" content="Swarm-on-swarm simulator using micromissiles for point defense">
|
||
<meta name="generator" content="VitePress v1.3.4">
|
||
<link rel="preload stylesheet" href="/micromissiles-unity/assets/style.ByW27x_6.css" as="style">
|
||
|
||
<script type="module" src="/micromissiles-unity/assets/app.CoSPHv2u.js"></script>
|
||
<link rel="preload" href="/micromissiles-unity/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/micromissiles-unity/assets/chunks/theme.ClAeuI5Q.js">
|
||
<link rel="modulepreload" href="/micromissiles-unity/assets/chunks/framework.DYF6f1aH.js">
|
||
<link rel="modulepreload" href="/micromissiles-unity/assets/Development_Guide.md.Wx7fNEd3.lean.js">
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar" data-v-ae24b3ad data-v-6aa21345><div class="wrapper" data-v-6aa21345><div class="container" data-v-6aa21345><div class="title" data-v-6aa21345><div class="VPNavBarTitle has-sidebar" data-v-6aa21345 data-v-ab179fa1><a class="title" href="/micromissiles-unity/" data-v-ab179fa1><!--[--><!--]--><!----><span data-v-ab179fa1>micromissiles-unity</span><!--[--><!--]--></a></div></div><div class="content" data-v-6aa21345><div class="content-body" data-v-6aa21345><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6aa21345><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6aa21345 data-v-dc692963><span id="main-nav-aria-label" class="visually-hidden" data-v-dc692963> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/micromissiles-unity/" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/micromissiles-unity/Keybinds_and_Controls.html" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>Documentation</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/micromissiles-unity/Development_Guide.html" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>Development Guide</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6aa21345 data-v-6c893767><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-6c893767 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6aa21345 data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/PisterLab/micromissiles-unity" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-6aa21345 data-v-bb2aa2f0 data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b6c34ac9><span class="vpi-more-horizontal icon" data-v-b6c34ac9></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-b98bc113><!----><!--[--><!--[--><!----><div class="group" data-v-bb2aa2f0><div class="item appearance" data-v-bb2aa2f0><p class="label" data-v-bb2aa2f0>Appearance</p><div class="appearance-action" data-v-bb2aa2f0><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bb2aa2f0 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div></div></div><div class="group" data-v-bb2aa2f0><div class="item social-links" data-v-bb2aa2f0><div class="VPSocialLinks social-links-list" data-v-bb2aa2f0 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/PisterLab/micromissiles-unity" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6aa21345 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-6aa21345><div class="divider-line" data-v-6aa21345></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-17a5e62e><button data-v-17a5e62e>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-319d5ca6><div class="curtain" data-v-319d5ca6></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-319d5ca6><span class="visually-hidden" id="sidebar-aria-label" data-v-319d5ca6> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 has-active" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Documentation</h2><!----></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/micromissiles-unity/Keybinds_and_Controls.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Keybinds and Controls</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/micromissiles-unity/Simulation_Config_Guide.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Simulation Configuration Guide</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/micromissiles-unity/Simulation_Logging.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Simulation Logging</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/micromissiles-unity/coverage/editmode/Report/" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Coverage Reports</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/micromissiles-unity/Development_Guide.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Development Guide</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-3f215769 data-v-a5bbad30><div class="content" data-v-a5bbad30><div class="outline-marker" data-v-a5bbad30></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a5bbad30>On this page</div><ul class="VPDocOutlineItem root" data-v-a5bbad30 data-v-b933a997><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _micromissiles-unity_Development_Guide" data-v-39a288b8><div><h1 id="development-guide" tabindex="-1">Development Guide <a class="header-anchor" href="#development-guide" aria-label="Permalink to "Development Guide""></a></h1><p>This guide will help you set up and run the project in development mode. You'll learn how to install Unity Hub, open the project, and navigate the main scene.</p><h2 id="table-of-contents" tabindex="-1">Table of Contents <a class="header-anchor" href="#table-of-contents" aria-label="Permalink to "Table of Contents""></a></h2><ul><li><a href="#prerequisites">Prerequisites</a></li><li><a href="#installation-steps">Installation Steps</a><ul><li><a href="#1-install-unity-hub">1. Install Unity Hub</a></li><li><a href="#2-clone-the-project-repository">2. Clone the Project Repository</a></li><li><a href="#3-launch-the-project-via-unity-hub">3. Launch the Project via Unity Hub</a></li><li><a href="#4-open-the-main-scene">4. Open the Main Scene</a></li></ul></li><li><a href="#next-steps">Next Steps</a></li><li><a href="#additional-resources">Additional Resources</a></li></ul><h2 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to "Prerequisites""></a></h2><ul><li>A computer with internet access.</li><li>Administrative privileges to install software.</li><li><a href="https://git-scm.com/downloads" target="_blank" rel="noreferrer">Git</a> installed on your system (optional, for cloning the repository).</li></ul><h2 id="installation-steps" tabindex="-1">Installation Steps <a class="header-anchor" href="#installation-steps" aria-label="Permalink to "Installation Steps""></a></h2><h3 id="_1-install-unity-hub" tabindex="-1">1. Install Unity Hub <a class="header-anchor" href="#_1-install-unity-hub" aria-label="Permalink to "1. Install Unity Hub""></a></h3><p>Unity Hub is a desktop application that manages your Unity projects and installations. It simplifies the process of installing different Unity versions and launching projects.</p><p><strong>Steps to Install Unity Hub:</strong></p><ol><li>Visit the <a href="https://unity3d.com/get-unity/download" target="_blank" rel="noreferrer">Unity Download Page</a>.</li><li>Click on <strong>"Download Unity Hub"</strong>.</li><li>Run the downloaded installer and follow the on-screen instructions to complete the installation.</li></ol><h3 id="_2-clone-the-project-repository" tabindex="-1">2. Clone the Project Repository <a class="header-anchor" href="#_2-clone-the-project-repository" aria-label="Permalink to "2. Clone the Project Repository""></a></h3><p>Obtain the project source code by cloning the repository from GitHub.</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> clone</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://github.com/PisterLab/micromissiles-unity.git</span></span></code></pre></div><p>Alternatively, you can download the repository as a ZIP file and extract it to a preferred location.</p><h3 id="_3-launch-the-project-via-unity-hub" tabindex="-1">3. Launch the Project via Unity Hub <a class="header-anchor" href="#_3-launch-the-project-via-unity-hub" aria-label="Permalink to "3. Launch the Project via Unity Hub""></a></h3><p><img src="/micromissiles-unity/assets/unity_hub.cJHZjOmp.png" alt="Unity Hub"></p><ol><li><p><strong>Open Unity Hub</strong>.</p></li><li><p><strong>Add the Project to Unity Hub</strong>:</p><ul><li>Navigate to the <strong>"Projects"</strong> tab.</li><li>Click on the <strong>"ADD"</strong> button.</li><li>Browse to the folder where you cloned or extracted the project.</li><li>Select the folder containing the <code>Assets</code> folder and click on <strong>"Select Folder"</strong>.</li></ul></li><li><p><strong>Install the Required Unity Version</strong>:</p><ul><li>Unity Hub will detect if the project requires a Unity version that is not currently installed.</li><li>A notification or warning icon may appear next to the project name.</li><li>Click on the notification and select <strong>"Install Unity <strong>[version]</strong>"</strong>.</li><li>Unity Hub will download and install the required Unity version automatically.</li></ul></li><li><p><strong>Open the Project</strong>:</p><ul><li>Once the required Unity version is installed, click on the project name in Unity Hub to open it.</li></ul></li></ol><h3 id="_4-open-the-main-scene" tabindex="-1">4. Open the Main Scene <a class="header-anchor" href="#_4-open-the-main-scene" aria-label="Permalink to "4. Open the Main Scene""></a></h3><p>After the project opens in Unity:</p><ol><li><p>In the <strong>Project</strong> window (usually located at the bottom), navigate to:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Assets/Scenes/</span></span></code></pre></div></li><li><p>Find the main scene file, usually named <code>MainScene.unity</code>.</p></li><li><p>Double-click on <code>MainScene.unity</code> to open it.</p></li><li><p>The scene will load in the <strong>Scene</strong> view. You can now run the simulation by clicking the <strong>Play</strong> button at the top of the Unity Editor.</p></li></ol><h2 id="additional-resources" tabindex="-1">Additional Resources <a class="header-anchor" href="#additional-resources" aria-label="Permalink to "Additional Resources""></a></h2><ul><li><a href="./Keybinds_and_Controls.html">Keybinds and Controls</a></li><li><a href="./Simulation_Config_Guide.html">Simulation Configuration Guide</a></li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/micromissiles-unity/coverage/editmode/Report/" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>Coverage Reports</span><!--]--></a></div><div class="pager" data-v-e257564d><!----></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5d98c3a5 data-v-e315a0ad><div class="container" data-v-e315a0ad><p class="message" data-v-e315a0ad>Released under the <a href="https://github.com/PisterLab/micromissiles-unity/blob/main/LICENSE">BSD-3-Clause License</a>.</p><p class="copyright" data-v-e315a0ad>Copyright © 2024-present, The Regents of the University of California (Regents). All Rights Reserved.</p></div></footer><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"development_guide.md\":\"Wx7fNEd3\",\"index.md\":\"CVOWUTll\",\"keybinds_and_controls.md\":\"CAuuuHw7\",\"markdown_examples.md\":\"BJC7tN3K\",\"simulation_config_guide.md\":\"BZQcs5Eb\",\"simulation_logging.md\":\"t33KQhfo\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"micromissiles-unity\",\"description\":\"Swarm-on-swarm simulator using micromissiles for point defense\",\"base\":\"/micromissiles-unity/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Documentation\",\"link\":\"/Keybinds_and_Controls\"},{\"text\":\"Development Guide\",\"link\":\"/Development_Guide\"}],\"sidebar\":[{\"text\":\"Documentation\",\"items\":[{\"text\":\"Keybinds and Controls\",\"link\":\"/Keybinds_and_Controls\"},{\"text\":\"Simulation Configuration Guide\",\"link\":\"/Simulation_Config_Guide\"},{\"text\":\"Simulation Logging\",\"link\":\"/Simulation_Logging\"},{\"text\":\"Coverage Reports\",\"link\":\"/coverage/editmode/Report/\"},{\"text\":\"Development Guide\",\"link\":\"/Development_Guide\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/PisterLab/micromissiles-unity\"}],\"search\":{\"provider\":\"local\"},\"footer\":{\"message\":\"Released under the <a href=\\\"https://github.com/PisterLab/micromissiles-unity/blob/main/LICENSE\\\">BSD-3-Clause License</a>.\",\"copyright\":\"Copyright © 2024-present, The Regents of the University of California (Regents). All Rights Reserved.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||
|
||
</body>
|
||
</html> |