2024-05-12 17:20:19 +02:00

113 lines
7.4 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Proxima Inspector</title>
<link rel="icon" href="../icons/favicon.ico" />
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1">
<meta property="og:type" content="website">
<meta name="description" property="og:description" content="Proxima Inspector lets you connect to your live game from a web browser to inspect and edit any property. Just like the Unity editor!">
<meta name="image" property="og:image" content="../images/proxima-1200x630.png">
<meta http-equiv="content-security-policy" content="">
<link href="../_app/immutable/assets/_layout-1f0a7e97.css" rel="stylesheet">
<link href="../_app/immutable/assets/_layout-6847360b.css" rel="stylesheet">
</head>
<body>
<div>
<div class="flex flex-col items-center text-gray-300 w-full min-h-screen bg-[#222]"><div class="flex w-full justify-center items-start bg-[#111] text-white fixed z-20"><div class="flex grow justify-between items-center max-w-[1600px] p-4"><a href="https://www.unityproxima.com"><img src="../images/proxima_logo.png" class="w-[150px]" alt="Logo"></a>
<button class="lg:hidden"><img class="w-10" src="../icons/menu.png" alt="Menu"></button>
<div class="flex gap-10 items-center max-lg:hidden">
<a href="https://assetstore.unity.com/publishers/72095?aid=1101lqSYn" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Store</a>
<a href="https://app.unityproxima.com/connection" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Demo</a>
<a class="text-xl font-logo" href="../docs.html">Docs</a>
<a href="https://discord.gg/VM9cWJ9rjH" class="" referrerpolicy="origin" target="_blank" rel="external"><img width="100px" class="mt-1" src="../icons/discord.png" alt=""></a></div></div>
</div>
<div class="pt-[83px] w-full h-full flex flex-col items-center"><div class="w-full flex flex-col items-start min-h-screen max-w-[1600px] px-4"><button class="text-white font-body pt-5 lg:hidden">Go to page &gt;</button>
<div class="flex w-full min-h-full relative"><div class="h-full fixed border-r-orange-400 bg-[#222] border-r-2 max-lg:hidden"><div class="flex pt-10 flex-col w-[300px] gap-2 border-[#21a6f0] min-h-0 h-full overflow-auto"><b class="text-orange-400">Getting Started</b>
<a href="../docs.html" class="svelte-yue6wq">Installation</a>
<a href="../docs/features.html" class="svelte-yue6wq">Feature Overview</a>
<b class="text-orange-400 mt-5">Connection</b>
<a href="../docs/supported_platforms.html" class="svelte-yue6wq">Supported Platforms</a>
<a href="../docs/connect.html" class="svelte-yue6wq">Connect to Your Game</a>
<a href="../docs/security.html" class="svelte-yue6wq">Security Considerations</a>
<a href="../docs/all_config.html" class="svelte-yue6wq">All Configuration Options</a>
<b class="text-orange-400 mt-5">Inspector</b>
<a href="../docs/inspector.html" class="svelte-yue6wq">GameObject Inspector</a>
<a href="../docs/buttons.html" class="svelte-yue6wq">Adding Buttons</a>
<a href="../docs/faq.html" class="svelte-yue6wq">Frequently Asked Questions</a>
<b class="text-orange-400 mt-5">Logs</b>
<a href="../docs/logs.html" class="svelte-yue6wq">Log Viewer</a>
<a href="../docs/viewing_logs_offline.html" class="svelte-yue6wq">Viewing Logs Offline</a>
<b class="text-orange-400 mt-5">Console</b>
<a href="../docs/console.html" class="svelte-yue6wq">Console Window</a>
<a href="../docs/console_built_in.html" class="svelte-yue6wq">Built-in Commands</a>
<a href="../docs/console_custom.html" class="svelte-yue6wq">Custom Commands</a>
<b class="text-orange-400 mt-5">Extras</b>
<a href="../docs/deeplinks.html" class="svelte-yue6wq">Deep Links</a>
<div class="h-[200px] shrink-0"></div></div></div>
<div class="flex flex-col w-full lg:pl-10 py-10 lg:ml-[300px]"><div class="doc flex flex-col gap-5 svelte-yue6wq"><h1 class="mb-10">All Configuration Options</h1>
<img src="../docs/secure-config.png" alt="Proxima Secure Configuration">
<table class="bg-[#1D1D1D] mt-10"><tr><td class="whitespace-nowrap text-white"><b>Property</b></td>
<td class="text-white"><b>Description</b></td></tr>
<tr><td class="whitespace-nowrap text-white">Display Name</td>
<td>The name displayed to show in the browser when connected</td></tr>
<tr><td class="whitespace-nowrap text-white">Port</td>
<td>The port number to host the embedded Proxima server. Not used in WebGL builds.</td></tr>
<tr><td class="whitespace-nowrap text-white">Password</td>
<td>The password required to connect to Proxima. See <a href="../docs/security.html">the security docs</a>.</td></tr>
<tr><td class="whitespace-nowrap text-white">Use Https</td>
<td>Enables and disables HTTPS for encryption. See <a href="../docs/security.html">the security docs</a>. Not used in WebGL builds.</td></tr>
<tr><td class="whitespace-nowrap text-white">Certificate</td>
<td>Optional TLS certificate. By default, Proxima uses Proxima/Resources/Proxima/ProximaEmbeddedCert.pfx. See <a href="../docs/security.html">the security docs</a>. Not used in WebGL builds.</td></tr>
<tr><td class="whitespace-nowrap text-white">Certificate Password</td>
<td>Password for the TLS certificate. Not used in WebGL builds.</td></tr>
<tr><td class="whitespace-nowrap text-white">Run On Enable</td>
<td>Automatically starts the Proxima server when this component is enabled.</td></tr>
<tr><td class="whitespace-nowrap text-white">Log Buffer Size</td>
<td>Maximum number of log messages to keep in memory. See <a href="../docs/logs.html">the logs docs</a>.</td></tr>
<tr><td class="whitespace-nowrap text-white">Instantiate Status UI</td>
<td>Instantiates Proxima/Resources/Proxima/ProximaStatusUI.prefab on startup. This UI lets you see the current status of Proxima at the bottom of your screen.</td></tr>
<tr><td class="whitespace-nowrap text-white">Instantiate Connect UI</td>
<td>Instantiates Proxima/Resources/Proxima/ProximaConnectUI.prefab on startup. This UI appears when the user presses F2 and allows the user to start and stop the server with a display name and password.</td></tr>
<tr><td class="whitespace-nowrap text-white">Dont Destroy On Load</td>
<td>Adds the gameObject with the Proxima Inspector to the DontDestroyOnLoad scene, which keeps connections alive when transitioning between scenes.</td></tr>
<tr><td class="whitespace-nowrap text-white">Set Run In Background</td>
<td>When Proxima starts, sets Application.runInBackground to true. When Proxima stops,
sets Application.runInBackground back to its previous value. This allows Proxima
to work when connecting from a browser on the same device, since otherwise Unity
will pause the app when focus is set to the browser.</td></tr></table></div></div></div>
</div>
<div class="h-[200px] flex flex-col"><p class="text-gray-400 m-10">© 2023 Virtual Maker Corporation</p></div></div></div>
</div>
</body>
</html>