Improve settings default handling
This commit is contained in:
+1
-1
@@ -40,7 +40,7 @@ function init() {
|
||||
app.commandLine.removeSwitch("enable-features");
|
||||
app.commandLine.removeSwitch("disable-features");
|
||||
|
||||
if (hardwareAcceleration === false || process.argv.includes("--disable-gpu")) {
|
||||
if (!hardwareAcceleration || process.argv.includes("--disable-gpu")) {
|
||||
enableHardwareAcceleration = false;
|
||||
app.disableHardwareAcceleration();
|
||||
} else {
|
||||
|
||||
@@ -344,12 +344,11 @@ function buildBrowserWindowOptions(): BrowserWindowConstructorOptions {
|
||||
|
||||
const { transparent, macosVibrancyStyle } = VencordSettings.store;
|
||||
|
||||
const frameless = nativeTitleBar !== true;
|
||||
const backgroundColor =
|
||||
splashTheming !== false ? splashBackground : nativeTheme.shouldUseDarkColors ? "#313338" : "#ffffff";
|
||||
const frameless = !nativeTitleBar;
|
||||
const backgroundColor = splashTheming ? splashBackground : nativeTheme.shouldUseDarkColors ? "#313338" : "#ffffff";
|
||||
|
||||
const options: BrowserWindowConstructorOptions = {
|
||||
show: Settings.store.enableSplashScreen === false && !CommandLine.values["start-minimized"],
|
||||
show: !Settings.store.enableSplashScreen && !CommandLine.values["start-minimized"],
|
||||
backgroundColor,
|
||||
webPreferences: {
|
||||
nodeIntegration: false,
|
||||
@@ -363,8 +362,8 @@ function buildBrowserWindowOptions(): BrowserWindowConstructorOptions {
|
||||
},
|
||||
frame: !frameless,
|
||||
autoHideMenuBar: enableMenu,
|
||||
hasShadow: enableShadow !== false,
|
||||
roundedCorners: enableRoundedCorners !== false,
|
||||
hasShadow: enableShadow,
|
||||
roundedCorners: enableRoundedCorners,
|
||||
...getWindowBoundsOptions()
|
||||
};
|
||||
|
||||
@@ -410,7 +409,7 @@ function createMainWindow() {
|
||||
if (process.platform === "darwin" && Settings.store.nativeTitleBar) win.setWindowButtonVisibility(false);
|
||||
|
||||
win.on("close", e => {
|
||||
const useTray = !isDeckGameMode && Settings.store.minimizeToTray !== false && Settings.store.tray !== false;
|
||||
const useTray = !isDeckGameMode && Settings.store.minimizeToTray && Settings.store.tray;
|
||||
if (isQuitting || (process.platform !== "darwin" && !useTray)) return;
|
||||
|
||||
e.preventDefault();
|
||||
@@ -470,7 +469,7 @@ export async function createWindows() {
|
||||
const startMinimized = CommandLine.values["start-minimized"];
|
||||
|
||||
let splash: BrowserWindow | undefined;
|
||||
if (Settings.store.enableSplashScreen !== false) {
|
||||
if (Settings.store.enableSplashScreen) {
|
||||
splash = createSplashWindow(startMinimized);
|
||||
|
||||
// SteamOS letterboxes and scales it terribly, so just full screen it
|
||||
|
||||
@@ -7,15 +7,17 @@
|
||||
import { type Settings as TVencordSettings } from "@vencord/types/Vencord";
|
||||
import { mkdirSync, readFileSync, writeFileSync } from "fs";
|
||||
import { dirname, join } from "path";
|
||||
import { DefaultVesktopSettings } from "shared/defaultSettings";
|
||||
import type { Settings as TSettings, State as TState } from "shared/settings";
|
||||
import { SettingsStore } from "shared/utils/SettingsStore";
|
||||
|
||||
import { DATA_DIR, VENCORD_SETTINGS_FILE } from "./constants";
|
||||
import { mergeDefaults } from "./utils/mergeDefaults";
|
||||
|
||||
const SETTINGS_FILE = join(DATA_DIR, "settings.json");
|
||||
const STATE_FILE = join(DATA_DIR, "state.json");
|
||||
|
||||
function loadSettings<T extends object = any>(file: string, name: string) {
|
||||
function loadSettings<T extends object = any>(file: string, name: string, defaults?: T) {
|
||||
let settings = {} as T;
|
||||
try {
|
||||
const content = readFileSync(file, "utf8");
|
||||
@@ -26,6 +28,10 @@ function loadSettings<T extends object = any>(file: string, name: string) {
|
||||
}
|
||||
} catch {}
|
||||
|
||||
if (defaults) {
|
||||
mergeDefaults(settings, defaults);
|
||||
}
|
||||
|
||||
const store = new SettingsStore(settings);
|
||||
store.addGlobalChangeListener(o => {
|
||||
try {
|
||||
@@ -39,6 +45,6 @@ function loadSettings<T extends object = any>(file: string, name: string) {
|
||||
return store;
|
||||
}
|
||||
|
||||
export const Settings = loadSettings<TSettings>(SETTINGS_FILE, "Vesktop settings");
|
||||
export const Settings = loadSettings<TSettings>(SETTINGS_FILE, "Vesktop settings", DefaultVesktopSettings);
|
||||
export const VencordSettings = loadSettings<TVencordSettings>(VENCORD_SETTINGS_FILE, "Vencord settings");
|
||||
export const State = loadSettings<TState>(STATE_FILE, "Vesktop state");
|
||||
|
||||
+1
-1
@@ -26,7 +26,7 @@ export function createSplashWindow(startMinimized = false) {
|
||||
|
||||
const { splashBackground, splashColor, splashTheming, splashPixelated } = Settings.store;
|
||||
|
||||
if (splashTheming !== false) {
|
||||
if (splashTheming) {
|
||||
if (splashColor) {
|
||||
const semiTransparentSplashColor = splashColor.replace("rgb(", "rgba(").replace(")", ", 0.2)");
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
/*
|
||||
* Vesktop, a desktop app aiming to give you a snappier Discord Experience
|
||||
* Copyright (c) 2026 Vendicated and Vesktop contributors
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
|
||||
/**
|
||||
* Recursively merges defaults into an object and returns the same object
|
||||
* @param obj Object
|
||||
* @param defaults Defaults
|
||||
* @returns obj
|
||||
*/
|
||||
export function mergeDefaults<T>(obj: T, defaults: T): T {
|
||||
for (const key in defaults) {
|
||||
const v = defaults[key];
|
||||
if (typeof v === "object" && !Array.isArray(v)) {
|
||||
obj[key] ??= {} as any;
|
||||
mergeDefaults(obj[key], v);
|
||||
} else {
|
||||
obj[key] ??= v;
|
||||
}
|
||||
}
|
||||
return obj;
|
||||
}
|
||||
@@ -14,7 +14,7 @@ let GuildReadStateStore: any;
|
||||
let NotificationSettingsStore: any;
|
||||
|
||||
export function setBadge() {
|
||||
if (Settings.store.appBadge === false) return;
|
||||
if (!Settings.store.appBadge) return;
|
||||
|
||||
try {
|
||||
const mentionCount = GuildReadStateStore.getTotalMentionCount();
|
||||
|
||||
@@ -27,7 +27,7 @@ export const AutoStartToggle: SettingsComponent = ({ settings }) => {
|
||||
<VesktopSettingsSwitch
|
||||
title="Auto Start Minimized"
|
||||
description={"Start Vesktop minimized when starting with system"}
|
||||
value={settings.autoStartMinimized ?? false}
|
||||
value={settings.autoStartMinimized}
|
||||
onChange={v => (settings.autoStartMinimized = v)}
|
||||
disabled={!autoStartEnabled}
|
||||
/>
|
||||
|
||||
@@ -14,7 +14,7 @@ export const NotificationBadgeToggle: SettingsComponent = ({ settings }) => {
|
||||
<VesktopSettingsSwitch
|
||||
title="Notification Badge"
|
||||
description="Show mention badge on the app icon"
|
||||
value={settings.appBadge ?? true}
|
||||
value={settings.appBadge}
|
||||
onChange={v => {
|
||||
settings.appBadge = v;
|
||||
if (v) setBadge();
|
||||
|
||||
@@ -10,7 +10,7 @@ import { classNameFactory } from "@vencord/types/api/Styles";
|
||||
import { BaseText, Divider, ErrorBoundary } from "@vencord/types/components";
|
||||
import { ComponentType } from "react";
|
||||
import { WebRTCIPHandlingPolicyPicker } from "renderer/components/settings/WebRTCIPHandlingPolicyPicker";
|
||||
import { Settings, useSettings } from "renderer/settings";
|
||||
import { getValueAndOnChange, Settings, useSettings } from "renderer/settings";
|
||||
import { isMac } from "renderer/utils";
|
||||
|
||||
import { AutoStartToggle } from "./AutoStartToggle";
|
||||
@@ -26,7 +26,6 @@ interface BooleanSetting {
|
||||
key: keyof typeof Settings.store;
|
||||
title: string;
|
||||
description: string;
|
||||
defaultValue: boolean;
|
||||
disabled?(): boolean;
|
||||
invisible?(): boolean;
|
||||
}
|
||||
@@ -42,64 +41,55 @@ const SettingsOptions: Record<string, Array<BooleanSetting | SettingsComponent>>
|
||||
{
|
||||
key: "hardwareAcceleration",
|
||||
title: "Hardware Acceleration",
|
||||
description: "Enable hardware acceleration",
|
||||
defaultValue: true
|
||||
description: "Enable hardware acceleration"
|
||||
},
|
||||
{
|
||||
key: "hardwareVideoAcceleration",
|
||||
title: "Video Hardware Acceleration",
|
||||
description:
|
||||
"Enable hardware video acceleration. This can improve performance of screenshare and video playback, but may cause graphical glitches and infinitely loading streams.",
|
||||
defaultValue: false,
|
||||
disabled: () => Settings.store.hardwareAcceleration === false
|
||||
disabled: () => !Settings.store.hardwareAcceleration
|
||||
}
|
||||
],
|
||||
"User Interface": [
|
||||
{
|
||||
key: "nativeTitleBar",
|
||||
title: "Native Titlebar",
|
||||
description: "Enable the system titlebar in addition to Discord's custom one. Requires a full restart.",
|
||||
defaultValue: false
|
||||
description: "Enable the system titlebar in addition to Discord's custom one. Requires a full restart."
|
||||
},
|
||||
{
|
||||
key: "staticTitle",
|
||||
title: "Static Title",
|
||||
description: 'Makes the window title "Vesktop" instead of changing to the current page',
|
||||
defaultValue: false
|
||||
description: 'Makes the window title "Vesktop" instead of changing to the current page'
|
||||
},
|
||||
{
|
||||
key: "enableMenu",
|
||||
title: "Enable Menu Bar",
|
||||
description: "Enables the application menu bar. Press ALT to toggle visibility.",
|
||||
defaultValue: false,
|
||||
disabled: () => Settings.store.nativeTitleBar !== true
|
||||
},
|
||||
{
|
||||
key: "enableShadow",
|
||||
title: "Enable Window Shadow",
|
||||
description: "Enables the window shadow. Requires a full restart.",
|
||||
defaultValue: true,
|
||||
disabled: () => Settings.store.nativeTitleBar === true
|
||||
},
|
||||
{
|
||||
key: "enableRoundedCorners",
|
||||
title: "Enable Rounded Corners",
|
||||
description: "Enables rounded corners. Requires a full restart.",
|
||||
defaultValue: true,
|
||||
disabled: () => Settings.store.nativeTitleBar === true
|
||||
},
|
||||
{
|
||||
key: "enableSplashScreen",
|
||||
title: "Enable Splash Screen",
|
||||
description:
|
||||
"Shows a small splash screen while Vesktop is loading. Disabling this option will show the main window earlier while it's still loading.",
|
||||
defaultValue: true
|
||||
"Shows a small splash screen while Vesktop is loading. Disabling this option will show the main window earlier while it's still loading."
|
||||
},
|
||||
{
|
||||
key: "splashTheming",
|
||||
title: "Splash theming",
|
||||
description: "Adapt the splash window colors to your custom theme",
|
||||
defaultValue: true
|
||||
description: "Adapt the splash window colors to your custom theme"
|
||||
},
|
||||
WindowsTransparencyControls,
|
||||
UserAssetsButton
|
||||
@@ -109,34 +99,29 @@ const SettingsOptions: Record<string, Array<BooleanSetting | SettingsComponent>>
|
||||
key: "tray",
|
||||
title: "Tray Icon",
|
||||
description: "Add a tray icon for Vesktop",
|
||||
defaultValue: true,
|
||||
invisible: () => isMac
|
||||
},
|
||||
{
|
||||
key: "minimizeToTray",
|
||||
title: "Minimize to tray",
|
||||
description: "Hitting X will make Vesktop minimize to the tray instead of closing",
|
||||
defaultValue: true,
|
||||
invisible: () => isMac,
|
||||
disabled: () => Settings.store.tray === false
|
||||
disabled: () => !Settings.store.tray
|
||||
},
|
||||
{
|
||||
key: "clickTrayToShowHide",
|
||||
title: "Hide/Show on tray click",
|
||||
description: "Left clicking tray icon will toggle the vesktop window visibility.",
|
||||
defaultValue: false
|
||||
description: "Left clicking tray icon will toggle the vesktop window visibility."
|
||||
},
|
||||
{
|
||||
key: "disableMinSize",
|
||||
title: "Disable minimum window size",
|
||||
description: "Allows you to make the window as small as your heart desires",
|
||||
defaultValue: false
|
||||
description: "Allows you to make the window as small as your heart desires"
|
||||
},
|
||||
{
|
||||
key: "disableSmoothScroll",
|
||||
title: "Disable smooth scrolling",
|
||||
description: "Disables smooth scrolling",
|
||||
defaultValue: false
|
||||
description: "Disables smooth scrolling"
|
||||
}
|
||||
],
|
||||
Notifications: [
|
||||
@@ -144,23 +129,20 @@ const SettingsOptions: Record<string, Array<BooleanSetting | SettingsComponent>>
|
||||
{
|
||||
key: "enableTaskbarFlashing",
|
||||
title: "Enable Taskbar Flashing",
|
||||
description: "Flashes the app in your taskbar when you have new notifications.",
|
||||
defaultValue: false
|
||||
description: "Flashes the app in your taskbar when you have new notifications."
|
||||
}
|
||||
],
|
||||
Miscellaneous: [
|
||||
{
|
||||
key: "arRPC",
|
||||
title: "Rich Presence",
|
||||
description: "Enables Rich Presence via arRPC",
|
||||
defaultValue: false
|
||||
description: "Enables Rich Presence via arRPC"
|
||||
},
|
||||
|
||||
{
|
||||
key: "openLinksWithElectron",
|
||||
title: "Open Links in app (experimental)",
|
||||
description: "Opens links in a new Vesktop window instead of your web browser",
|
||||
defaultValue: false
|
||||
description: "Opens links in a new Vesktop window instead of your web browser"
|
||||
},
|
||||
|
||||
WebRTCIPHandlingPolicyPicker
|
||||
@@ -182,16 +164,15 @@ function SettingsSections() {
|
||||
{settings.map((Setting, i) => {
|
||||
if (typeof Setting === "function") return <Setting key={`Custom-${i}`} settings={Settings} />;
|
||||
|
||||
const { defaultValue, title, description, key, disabled, invisible } = Setting;
|
||||
const { title, description, key, disabled, invisible } = Setting;
|
||||
if (invisible?.()) return null;
|
||||
|
||||
return (
|
||||
<VesktopSettingsSwitch
|
||||
title={title}
|
||||
description={description}
|
||||
value={Settings[key as any] ?? defaultValue}
|
||||
onChange={v => (Settings[key as any] = v)}
|
||||
disabled={disabled?.()}
|
||||
{...getValueAndOnChange(key)}
|
||||
key={key}
|
||||
/>
|
||||
);
|
||||
|
||||
@@ -74,7 +74,7 @@ function Asset({ asset }: { asset: UserAssetType }) {
|
||||
{isSplash && (
|
||||
<FormSwitch
|
||||
title="Nearest-Neighbor Scaling (for pixel art)"
|
||||
value={settings.splashPixelated ?? false}
|
||||
value={settings.splashPixelated}
|
||||
onChange={val => (settings.splashPixelated = val)}
|
||||
className={Margins.top16}
|
||||
hideBorder
|
||||
|
||||
@@ -33,7 +33,7 @@ export const WebRTCIPHandlingPolicyPicker: SettingsComponent = ({ settings }) =>
|
||||
]}
|
||||
closeOnSelect={true}
|
||||
select={v => (settings.webRTCIPHandlingPolicy = v)}
|
||||
isSelected={v => v === (settings.webRTCIPHandlingPolicy ?? "default")}
|
||||
isSelected={v => v === settings.webRTCIPHandlingPolicy}
|
||||
serialize={s => s}
|
||||
/>
|
||||
</div>
|
||||
|
||||
@@ -25,10 +25,12 @@ export function useSettings() {
|
||||
return Settings.store;
|
||||
}
|
||||
|
||||
export function getValueAndOnChange(key: keyof typeof Settings.store) {
|
||||
export function getValueAndOnChange<K extends keyof typeof Settings.store, V extends (typeof Settings.store)[K]>(
|
||||
key: K
|
||||
) {
|
||||
return {
|
||||
value: Settings.store[key] as any,
|
||||
onChange: (value: any) => (Settings.store[key] = value)
|
||||
value: Settings.store[key] as V,
|
||||
onChange: (value: V) => (Settings.store[key] = value)
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
/*
|
||||
* Vesktop, a desktop app aiming to give you a snappier Discord Experience
|
||||
* Copyright (c) 2026 Vendicated and Vesktop contributors
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
|
||||
import { Settings } from "./settings";
|
||||
|
||||
export const DefaultVesktopSettings: Settings = {
|
||||
discordBranch: "stable",
|
||||
hardwareAcceleration: true,
|
||||
hardwareVideoAcceleration: false,
|
||||
nativeTitleBar: false,
|
||||
staticTitle: false,
|
||||
enableMenu: false,
|
||||
enableShadow: true,
|
||||
enableRoundedCorners: true,
|
||||
enableSplashScreen: true,
|
||||
splashTheming: true,
|
||||
tray: true,
|
||||
minimizeToTray: true,
|
||||
clickTrayToShowHide: false,
|
||||
disableMinSize: false,
|
||||
disableSmoothScroll: false,
|
||||
enableTaskbarFlashing: false,
|
||||
arRPC: true,
|
||||
openLinksWithElectron: false,
|
||||
autoStartMinimized: false,
|
||||
splashPixelated: false,
|
||||
webRTCIPHandlingPolicy: "default",
|
||||
appBadge: true,
|
||||
transparencyOption: "none"
|
||||
};
|
||||
Vendored
+23
-23
@@ -7,36 +7,36 @@
|
||||
import type { Rectangle } from "electron";
|
||||
|
||||
export interface Settings {
|
||||
discordBranch?: "stable" | "canary" | "ptb";
|
||||
transparencyOption?: "none" | "mica" | "tabbed" | "acrylic";
|
||||
webRTCIPHandlingPolicy?:
|
||||
discordBranch: "stable" | "canary" | "ptb";
|
||||
transparencyOption: "none" | "mica" | "tabbed" | "acrylic";
|
||||
webRTCIPHandlingPolicy:
|
||||
| "default"
|
||||
| "default_public_interface_only"
|
||||
| "default_public_and_private_interfaces"
|
||||
| "disable_non_proxied_udp";
|
||||
tray?: boolean;
|
||||
minimizeToTray?: boolean;
|
||||
autoStartMinimized?: boolean;
|
||||
openLinksWithElectron?: boolean;
|
||||
staticTitle?: boolean;
|
||||
enableMenu?: boolean;
|
||||
enableShadow?: boolean;
|
||||
enableRoundedCorners?: boolean;
|
||||
disableSmoothScroll?: boolean;
|
||||
hardwareAcceleration?: boolean;
|
||||
hardwareVideoAcceleration?: boolean;
|
||||
arRPC?: boolean;
|
||||
appBadge?: boolean;
|
||||
enableTaskbarFlashing?: boolean;
|
||||
disableMinSize?: boolean;
|
||||
clickTrayToShowHide?: boolean;
|
||||
nativeTitleBar?: boolean;
|
||||
tray: boolean;
|
||||
minimizeToTray: boolean;
|
||||
autoStartMinimized: boolean;
|
||||
openLinksWithElectron: boolean;
|
||||
staticTitle: boolean;
|
||||
enableMenu: boolean;
|
||||
enableShadow: boolean;
|
||||
enableRoundedCorners: boolean;
|
||||
disableSmoothScroll: boolean;
|
||||
hardwareAcceleration: boolean;
|
||||
hardwareVideoAcceleration: boolean;
|
||||
arRPC: boolean;
|
||||
appBadge: boolean;
|
||||
enableTaskbarFlashing: boolean;
|
||||
disableMinSize: boolean;
|
||||
clickTrayToShowHide: boolean;
|
||||
nativeTitleBar: boolean;
|
||||
|
||||
enableSplashScreen?: boolean;
|
||||
splashTheming?: boolean;
|
||||
enableSplashScreen: boolean;
|
||||
splashTheming: boolean;
|
||||
splashPixelated: boolean;
|
||||
splashColor?: string;
|
||||
splashBackground?: string;
|
||||
splashPixelated?: boolean;
|
||||
|
||||
spellCheckLanguages?: string[];
|
||||
|
||||
|
||||
Reference in New Issue
Block a user