Skip to content

Commit

Permalink
feat(ui): add hash handler for configuration ids (#2002)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ReenigneArcher
ReenigneArcher authored Jan 14, 2024
1 parent 937d0d8 commit 1ccda51
Show file tree
Hide file tree
Showing 2 changed files with 152 additions and 74 deletions.
8 changes: 5 additions & 3 deletions docs/source/about/advanced_usage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,9 +320,11 @@ keybindings
**Default**
.. code-block:: text
0x10, 0xA0,
0x11, 0xA2,
0x12, 0xA4
[
0x10, 0xA0,
0x11, 0xA2,
0x12, 0xA4
]
**Example**
.. code-block:: text
Expand Down
218 changes: 147 additions & 71 deletions src_assets/common/assets/web/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1074,52 +1074,6 @@ <h2 class="accordion-header">
import { createApp } from 'vue'
import Navbar from './Navbar.vue'

// Create dictionary for defaultConfig
//
// Note: Please keep this in alphabetical order!
const defaultConfig = {
"address_family": "ipv4",
"always_send_scancodes": "enabled",
"amd_coder": "auto",
"amd_preanalysis": "disabled",
"amd_quality": "balanced",
"amd_rc": "vbr_latency",
"amd_usage": "ultralowlatency",
"amd_vbaq": "enabled",
"av1_mode": 0,
"capture": "",
"controller": "enabled",
"ds4_back_as_touchpad_click": "enabled",
"encoder": "",
"fps": "[10,30,60,90,120]",
"gamepad": "auto",
"global_prep_cmd": "[]",
"hevc_mode": 0,
"high_resolution_scrolling": "enabled",
"install_steam_audio_drivers": "enabled",
"key_rightalt_to_key_win": "disabled",
"keyboard": "enabled",
"min_log_level": 2,
"motion_as_ds4": "enabled",
"mouse": "enabled",
"native_pen_touch": "enabled",
"nvenc_h264_cavlc": "disabled",
"nvenc_preset": "1",
"nvenc_realtime_hags": "enabled",
"nvenc_twopass": "quarter_res",
"origin_web_ui_allowed": "lan",
"qsv_coder": "auto",
"qsv_preset": "medium",
"resolutions": "[352x240,480x360,858x480,1280x720,1920x1080,2560x1080,3440x1440,1920x1200,3840x2160,3840x1600]",
"sw_preset": "superfast",
"sw_tune": "zerolatency",
"touchpad_as_ds4": "enabled",
"upnp": "disabled",
"vt_coder": "auto",
"vt_realtime": "enabled",
"vt_software": "auto",
}

const app = createApp({
components: {
Navbar
Expand All @@ -1140,46 +1094,130 @@ <h2 class="accordion-header">
{
id: "general",
name: "General",
options: {
"sunshine_name": "",
"min_log_level": 2,
"global_prep_cmd": "[]",
},
},
{
id: "files",
name: "Files",
options: {
"file_apps": "",
"credentials_file": "",
"log_path": "",
"pkey": "",
"cert": "",
"file_state": "",
},
},
{
id: "input",
name: "Input",
options: {
"controller": "enabled",
"gamepad": "auto",
"ds4_back_as_touchpad_click": "enabled",
"motion_as_ds4": "enabled",
"touchpad_as_ds4": "enabled",
"back_button_timeout": -1,
"keyboard": "enabled",
"key_repeat_delay": 500,
"key_repeat_frequency": 24.9,
"always_send_scancodes": "enabled",
"key_rightalt_to_key_win": "disabled",

This comment has been minimized.

Sign in to view

Copy link
@lidawei97688

lidawei97688 Jan 4, 2025

localization context corresponding entry is "key_rightalt_to_key_windows"

This comment has been minimized.

Sign in to view

Copy link
@ReenigneArcher

ReenigneArcher Jan 4, 2025

Author Member

Will be fixed in #3455
"mouse": "enabled",
"high_resolution_scrolling": "enabled",
"native_pen_touch": "enabled",
"keybindings": "[0x10,0xA0,0x11,0xA2,0x12,0xA4]", // todo: add this to UI
},
},
{
id: "av",
name: "Audio/Video",
options: {
"audio_sink": "",
"virtual_sink": "",
"install_steam_audio_drivers": "enabled",
"adapter_name": "",
"output_name": "",
"resolutions": "[352x240,480x360,858x480,1280x720,1920x1080,2560x1080,3440x1440,1920x1200,3840x2160,3840x1600]",
"fps": "[10,30,60,90,120]",
},
},
{
id: "network",
name: "Network",
options: {
"address_family": "ipv4",
"port": 47989,
"origin_web_ui_allowed": "lan",
"upnp": "disabled",
"external_ip": "",
"ping_timeout": 10000,
},
},
{
id: "advanced",
name: "Advanced",
options: {
"channels": 1,
"fec_percentage": 20,
"qp": 28,
"min_threads": 1,
"hevc_mode": 0,
"av1_mode": 0,
"capture": "",
"encoder": "",
},
},
{
id: "nv",
name: "NVIDIA NVENC Encoder",
options: {
"nvenc_preset": 1,
"nvenc_twopass": "quarter_res",
"nvenc_realtime_hags": "enabled",
"nvenc_h264_cavlc": "disabled",
},
},
{
id: "qsv",
name: "Intel QuickSync Encoder",
options: {
"qsv_preset": "medium",
"qsv_coder": "auto",
},
},
{
id: "amd",
name: "AMD AMF Encoder",
options: {
"amd_quality": "balanced",
"amd_rc": "vbr_latency",
"amd_usage": "ultralowlatency",
"amd_preanalysis": "disabled",
"amd_vbaq": "enabled",
"amd_coder": "auto",
},
},
{
id: "vt",
name: "VideoToolbox Encoder",
options: {
"vt_coder": "auto",
"vt_software": "auto",
"vt_realtime": "enabled",
},
},
{
id: "sw",
name: "Software Encoder",
options: {
"sw_preset": "superfast",
"sw_tune": "zerolatency",
},
},
],
};
Expand Down Expand Up @@ -1212,12 +1250,15 @@ <h2 class="accordion-header">
delete this.config.platform;
delete this.config.status;
delete this.config.version;
//Populate default values if not present in config
for (let key in defaultConfig) {
if (this.config[key] === undefined) {
this.config[key] = defaultConfig[key]
}
}

// Populate default values from tabs options
this.tabs.forEach(tab => {
Object.keys(tab.options).forEach(optionKey => {
if (this.config[optionKey] === undefined) {
this.config[optionKey] = tab.options[optionKey];
}
});
});

this.fps = JSON.parse(this.config.fps);
//Resolutions should be fixed because are not valid JSON
Expand Down Expand Up @@ -1259,28 +1300,31 @@ <h2 class="accordion-header">
let config = JSON.parse(JSON.stringify(this.config))

// delete default values from this.config
for (let key in defaultConfig) {
let delete_value = false
if (key === "resolutions" || key === "fps") {
let regex = /([\d]+x[\d]+)/g
// Use a regular expression to find each value and replace it with a quoted version

let config_value = JSON.parse(config[key].replace(regex, '"$1"')).toString()
let default_value = JSON.parse(defaultConfig[key].replace(regex, '"$1"')).toString()
this.tabs.forEach(tab => {
Object.keys(tab.options).forEach(optionKey => {
let delete_value = false
if (optionKey === "global_prep_cmd" || optionKey === "resolutions" || optionKey === "fps") {
let regex = /([\d]+x[\d]+)/g // this regex is only needed for resolutions
// Use a regular expression to find each value and replace it with a quoted version

let config_value = JSON.parse(config[optionKey].replace(regex, '"$1"')).toString()
let default_value = JSON.parse(tab.options[optionKey].replace(regex, '"$1"')).toString()

if (config_value === default_value) {
delete_value = true
}
}

if (config_value === default_value) {
// todo: add proper type checking
if (String(config[optionKey]) === String(tab.options[optionKey])) {
delete_value = true
}
}

if (config[key] === defaultConfig[key]) {
delete_value = true
}

if (delete_value) {
delete config[key]
}
}
if (delete_value) {
delete config[optionKey]
}
});
});

return fetch("/api/config", {
method: "POST",
Expand Down Expand Up @@ -1332,7 +1376,39 @@ <h2 class="accordion-header">
// If so, default to config port. Otherwise, use the value of port.
return port ? port : 47989
},
}
},
mounted() {
// Handle hashchange events
const handleHash = () => {
let hash = window.location.hash;
if (hash) {
// remove the # from the hash
let stripped_hash = hash.substring(1);

this.tabs.forEach(tab => {
Object.keys(tab.options).forEach(key => {
if (key === stripped_hash) {
this.currentTab = tab.id;

// sleep for 2 seconds to allow the page to load
setTimeout(() => {
let element = document.getElementById(stripped_hash);
if (element) {
window.location.hash = hash;
}
}, 2000);
}
});
})
}
};

// Call handleHash for the initial load
handleHash();

// Add hashchange event listener
window.addEventListener("hashchange", handleHash);
},
});

app.mount("#app");
Expand Down

0 comments on commit 1ccda51

Please sign in to comment.