izackp/Apollo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(advanced-usage): cross reference config UI (#2000)

Browse Source
This commit is contained in:
ReenigneArcher
2024-01-14 08:16:02 -05:00
committed by GitHub
parent 1ccda51df9
commit ec1ae4a3fe
2 changed files with 855 additions and 808 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1615
docs/source/about/advanced_usage.rst
View File

File diff suppressed because it is too large Load Diff

38
src_assets/common/assets/web/config.html
View File

@@ -36,7 +36,7 @@
</ul> </ul>
<!-- General Tab --> <!-- General Tab -->
<div v-if="currentTab === 'general'" class="config-page"> <div id="general" v-if="currentTab === 'general'" class="config-page">
<!-- Sunshine Name --> <!-- Sunshine Name -->
<div class="mb-3"> <div class="mb-3">
<label for="sunshine_name" class="form-label">Sunshine Name</label> <label for="sunshine_name" class="form-label">Sunshine Name</label>
@@ -65,7 +65,7 @@
</div> </div>
<!-- Global Prep Commands --> <!-- Global Prep Commands -->
<div class="mb-3 d-flex flex-column"> <div id="global_prep_cmd" class="mb-3 d-flex flex-column">
<label class="form-label">Command Preparations</label> <label class="form-label">Command Preparations</label>
<div class="form-text"> <div class="form-text">
Configure a list of commands to be executed before or after running any application. Configure a list of commands to be executed before or after running any application.
@@ -115,7 +115,7 @@
</div> </div>
<!-- Files Tab --> <!-- Files Tab -->
<div v-if="currentTab === 'files'" class="config-page"> <div id="files" v-if="currentTab === 'files'" class="config-page">
<!-- Apps File --> <!-- Apps File -->
<div class="mb-3"> <div class="mb-3">
<label for="file_apps" class="form-label">Apps File</label> <label for="file_apps" class="form-label">Apps File</label>
@@ -174,11 +174,11 @@
</div> </div>
<!-- Input Tab --> <!-- Input Tab -->
<div v-if="currentTab === 'input'" class="config-page"> <div id="input" v-if="currentTab === 'input'" class="config-page">
<!-- Enable Gamepad Input --> <!-- Enable Gamepad Input -->
<div class="mb-3"> <div class="mb-3">
<label for="gamepad" class="form-label">Enable Gamepad Input</label> <label for="controller" class="form-label">Enable Gamepad Input</label>
<select id="gamepad" class="form-select" v-model="config.controller"> <select id="controller" class="form-select" v-model="config.controller">
<option value="disabled">Disabled</option> <option value="disabled">Disabled</option>
<option value="enabled">Enabled</option> <option value="enabled">Enabled</option>
</select> </select>
@@ -319,8 +319,8 @@
<!-- Mapping Key AltRight to Key Windows --> <!-- Mapping Key AltRight to Key Windows -->
<div class="mb-3" v-if="config.keyboard === 'enabled'"> <div class="mb-3" v-if="config.keyboard === 'enabled'">
<label for="mapkey" class="form-label">Map Right Alt key to Windows key</label> <label for="key_rightalt_to_key_win" class="form-label">Map Right Alt key to Windows key</label>
<select id="mapkey" class="form-select" v-model="config.key_rightalt_to_key_win"> <select id="key_rightalt_to_key_win" class="form-select" v-model="config.key_rightalt_to_key_win">
<option value="disabled">Disabled</option> <option value="disabled">Disabled</option>
<option value="enabled">Enabled</option> <option value="enabled">Enabled</option>
</select> </select>
@@ -373,7 +373,7 @@
</div> </div>
<!-- Audio/Video Tab --> <!-- Audio/Video Tab -->
<div v-if="currentTab === 'av'" class="config-page"> <div id="audio-video" v-if="currentTab === 'av'" class="config-page">
<!-- Audio Sink --> <!-- Audio Sink -->
<div class="mb-3" v-if="platform === 'windows'"> <div class="mb-3" v-if="platform === 'windows'">
<label for="audio_sink" class="form-label">Audio Sink</label> <label for="audio_sink" class="form-label">Audio Sink</label>
@@ -500,7 +500,7 @@
<!-- Display Modes --> <!-- Display Modes -->
<div class="mb-3"> <div class="mb-3">
<!-- Advertised Resolutions --> <!-- Advertised Resolutions -->
<div class="resolutions-container"> <div id="resolutions" class="resolutions-container">
<label>Advertised Resolutions</label> <label>Advertised Resolutions</label>
<div class="resolutions d-flex flex-wrap"> <div class="resolutions d-flex flex-wrap">
<div class="p-2 ms-item m-2 d-flex justify-content-between" v-for="(r,i) in resolutions" :key="r"> <div class="p-2 ms-item m-2 d-flex justify-content-between" v-for="(r,i) in resolutions" :key="r">
@@ -521,7 +521,7 @@
</div> </div>
<!-- Advertised FPS --> <!-- Advertised FPS -->
<div class="fps-container"> <div id="fps" class="fps-container">
<label>Advertised FPS</label> <label>Advertised FPS</label>
<div class="fps d-flex flex-wrap"> <div class="fps d-flex flex-wrap">
<div class="p-2 ms-item m-2 d-flex justify-content-between" v-for="(f,i) in fps" :key="f"> <div class="p-2 ms-item m-2 d-flex justify-content-between" v-for="(f,i) in fps" :key="f">
@@ -552,7 +552,7 @@
</div> </div>
<!-- Network Tab --> <!-- Network Tab -->
<div v-if="currentTab === 'network'" class="config-page"> <div id="network" v-if="currentTab === 'network'" class="config-page">
<!-- Address family --> <!-- Address family -->
<div class="mb-3"> <div class="mb-3">
<label for="address_family" class="form-label">Address Family</label> <label for="address_family" class="form-label">Address Family</label>
@@ -813,7 +813,7 @@
</div> </div>
<!-- NVIDIA NVENC Encoder Tab --> <!-- NVIDIA NVENC Encoder Tab -->
<div v-if="currentTab === 'nv'" class="config-page"> <div id="nvidia-nvenc-encoder" v-if="currentTab === 'nv'" class="config-page">
<!-- Performance preset --> <!-- Performance preset -->
<div class="mb-3"> <div class="mb-3">
<label for="nvenc_preset" class="form-label">Performance preset</label> <label for="nvenc_preset" class="form-label">Performance preset</label>
@@ -897,7 +897,7 @@
</div> </div>
<!-- Intel QuickSync Encoder Tab --> <!-- Intel QuickSync Encoder Tab -->
<div v-if="currentTab === 'qsv'" class="config-page"> <div id="intel-quicksync-encoder" v-if="currentTab === 'qsv'" class="config-page">
<!-- QuickSync Preset --> <!-- QuickSync Preset -->
<div class="mb-3"> <div class="mb-3">
<label for="qsv_preset" class="form-label">QuickSync Preset</label> <label for="qsv_preset" class="form-label">QuickSync Preset</label>
@@ -925,7 +925,7 @@
</div> </div>
<!-- AMD AMF Encoder Tab --> <!-- AMD AMF Encoder Tab -->
<div v-if="currentTab === 'amd'" class="config-page"> <div id="amd-amf-encoder" v-if="currentTab === 'amd'" class="config-page">
<!-- AMF Quality --> <!-- AMF Quality -->
<div class="mb-3"> <div class="mb-3">
<label for="amd_quality" class="form-label">AMF Quality</label> <label for="amd_quality" class="form-label">AMF Quality</label>
@@ -958,7 +958,7 @@
</select> </select>
</div> </div>
<!-- AMF Preanalysis --> <!-- AMD Preanalysis -->
<div class="mb-3"> <div class="mb-3">
<label for="amd_preanalysis" class="form-label">AMF Preanalysis</label> <label for="amd_preanalysis" class="form-label">AMF Preanalysis</label>
<select id="amd_preanalysis" class="form-select" v-model="config.amd_preanalysis"> <select id="amd_preanalysis" class="form-select" v-model="config.amd_preanalysis">
@@ -967,7 +967,7 @@
</select> </select>
</div> </div>
<!-- AMF VBAQ --> <!-- AMD VBAQ -->
<div class="mb-3"> <div class="mb-3">
<label for="amd_vbaq" class="form-label">AMF Variance Based Adaptive Quantization (VBAQ)</label> <label for="amd_vbaq" class="form-label">AMF Variance Based Adaptive Quantization (VBAQ)</label>
<select id="amd_vbaq" class="form-select" v-model="config.amd_vbaq"> <select id="amd_vbaq" class="form-select" v-model="config.amd_vbaq">
@@ -988,7 +988,7 @@
</div> </div>
<!-- VideoToolbox Encoder Tab --> <!-- VideoToolbox Encoder Tab -->
<div v-if="currentTab === 'vt'" class="config-page"> <div id="videotoolbox-encoder" v-if="currentTab === 'vt'" class="config-page">
<!-- Presets --> <!-- Presets -->
<div class="mb-3"> <div class="mb-3">
<label for="vt_coder" class="form-label">VideoToolbox Coder</label> <label for="vt_coder" class="form-label">VideoToolbox Coder</label>
@@ -1017,7 +1017,7 @@
</div> </div>
<!-- Software Encoder Tab --> <!-- Software Encoder Tab -->
<div v-if="currentTab === 'sw'" class="config-page"> <div id="software-encoder" v-if="currentTab === 'sw'" class="config-page">
<div class="mb-3"> <div class="mb-3">
<label for="sw_preset" class="form-label">SW Presets</label> <label for="sw_preset" class="form-label">SW Presets</label>
<select id="sw_preset" class="form-select" v-model="config.sw_preset"> <select id="sw_preset" class="form-select" v-model="config.sw_preset">