484 lines
16 KiB
TypeScript
484 lines
16 KiB
TypeScript
/*
|
|
* Vencord, a Discord client mod
|
|
* Copyright (c) 2025 Vendicated and contributors
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*/
|
|
|
|
import { definePluginSettings } from "@api/Settings";
|
|
import { BackupRestoreIcon, CloudIcon, MainSettingsIcon, PaintbrushIcon, PatchHelperIcon, PlaceholderIcon, PluginsIcon, UpdaterIcon, VesktopSettingsIcon } from "@components/Icons";
|
|
import {
|
|
BackupAndRestoreTab,
|
|
ChangelogTab,
|
|
CloudTab,
|
|
PatchHelperTab,
|
|
PluginsTab,
|
|
ThemesTab,
|
|
UpdaterTab,
|
|
VencordTab,
|
|
} from "@components/settings";
|
|
import { gitHashShort } from "@shared/vencordUserAgent";
|
|
import { Devs } from "@utils/constants";
|
|
import { getIntlMessage } from "@utils/discord";
|
|
import { isTruthy } from "@utils/guards";
|
|
import definePlugin, { IconProps, OptionType } from "@utils/types";
|
|
import { waitFor } from "@webpack";
|
|
import { React } from "@webpack/common";
|
|
import type { ComponentType, PropsWithChildren, ReactNode } from "react";
|
|
|
|
let LayoutTypes = {
|
|
SECTION: 1,
|
|
SIDEBAR_ITEM: 2,
|
|
PANEL: 3,
|
|
PANE: 4
|
|
};
|
|
waitFor(["SECTION", "SIDEBAR_ITEM", "PANEL", "PANE"], v => LayoutTypes = v);
|
|
|
|
const FallbackSectionTypes = {
|
|
HEADER: "HEADER",
|
|
DIVIDER: "DIVIDER",
|
|
CUSTOM: "CUSTOM"
|
|
};
|
|
type SectionTypes = typeof FallbackSectionTypes;
|
|
|
|
type SettingsLocation =
|
|
| "top"
|
|
| "aboveNitro"
|
|
| "belowNitro"
|
|
| "aboveActivity"
|
|
| "belowActivity"
|
|
| "bottom";
|
|
|
|
interface SettingsLayoutNode {
|
|
type: number;
|
|
key?: string;
|
|
legacySearchKey?: string;
|
|
useLabel?(): string;
|
|
useTitle?(): string;
|
|
buildLayout?(): SettingsLayoutNode[];
|
|
icon?(): ReactNode;
|
|
render?(): ReactNode;
|
|
}
|
|
|
|
interface EntryOptions {
|
|
key: string,
|
|
title: string,
|
|
panelTitle?: string,
|
|
Component: ComponentType<{}>,
|
|
Icon: ComponentType<IconProps>;
|
|
}
|
|
interface SettingsLayoutBuilder {
|
|
key?: string;
|
|
buildLayout(): SettingsLayoutNode[];
|
|
}
|
|
|
|
const settings = definePluginSettings({
|
|
settingsLocation: {
|
|
type: OptionType.SELECT,
|
|
description: "Where to put the Equicord settings section",
|
|
options: [
|
|
{ label: "At the very top", value: "top" },
|
|
{ label: "Above the Nitro section", value: "aboveNitro", default: true },
|
|
{ label: "Below the Nitro section", value: "belowNitro" },
|
|
{ label: "Above Activity Settings", value: "aboveActivity" },
|
|
{ label: "Below Activity Settings", value: "belowActivity" },
|
|
{ label: "At the very bottom", value: "bottom" },
|
|
] as { label: string; value: SettingsLocation; default?: boolean; }[]
|
|
}
|
|
});
|
|
|
|
export function buildEntry(options: EntryOptions): SettingsLayoutNode {
|
|
const { key, title, panelTitle = title, Component, Icon } = options;
|
|
|
|
return ({
|
|
key,
|
|
type: LayoutTypes.SIDEBAR_ITEM,
|
|
legacySearchKey: title.toUpperCase(),
|
|
useTitle: () => title,
|
|
icon: () => <Icon width={20} height={20} />,
|
|
buildLayout: () => [
|
|
{
|
|
key: key + "_panel",
|
|
type: LayoutTypes.PANEL,
|
|
useTitle: () => panelTitle,
|
|
buildLayout: () => [
|
|
{
|
|
key: key + "_pane",
|
|
type: LayoutTypes.PANE,
|
|
buildLayout: () => [],
|
|
render: () => <Component />,
|
|
useTitle: () => panelTitle
|
|
}
|
|
]
|
|
}
|
|
]
|
|
});
|
|
}
|
|
|
|
export default definePlugin({
|
|
name: "Settings",
|
|
description: "Adds Settings UI and debug info",
|
|
authors: [Devs.Ven, Devs.Megu],
|
|
required: true,
|
|
|
|
settings,
|
|
|
|
patches: [
|
|
{
|
|
find: ".versionHash",
|
|
replacement: [
|
|
{
|
|
match: /\.compactInfo.+?(?=null!=(\i)&&(.{0,20}\i\.Text.{0,200}?,children:).{0,15}?("span"),({className:\i\.versionHash,children:\["Build Override: ",\1\.id\]\})\)\}\))/,
|
|
replace: (m, _buildOverride, makeRow, component, props) => {
|
|
props = props.replace(/children:\[.+\]/, "");
|
|
return `${m},$self.makeInfoElements(${component},${props}).map(e=>${makeRow}e})),`;
|
|
}
|
|
},
|
|
{
|
|
match: /\.info.+?\[\(0,\i\.jsxs?\)\((.{1,10}),(\{[^{}}]+\{.{0,20}.versionHash,.+?\})\)," "/,
|
|
replace: (m, component, props) => {
|
|
props = props.replace(/children:\[.+\]/, "");
|
|
return `${m},$self.makeInfoElements(${component},${props})`;
|
|
}
|
|
},
|
|
{
|
|
match: /copyValue:\i\.join\(" "\)/g,
|
|
replace: "$& + $self.getInfoString()"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
find: ".SEARCH_NO_RESULTS&&0===",
|
|
replacement: [
|
|
{
|
|
match: /(?<=section:(.{0,50})\.DIVIDER\}\))([,;])(?=.{0,200}(\i)\.push.{0,100}label:(\i)\.header)/,
|
|
replace: (
|
|
_,
|
|
sectionTypes,
|
|
commaOrSemi,
|
|
elements,
|
|
element,
|
|
) =>
|
|
`${commaOrSemi} $self.addSettings(${elements}, ${element}, ${sectionTypes}) ${commaOrSemi}`,
|
|
},
|
|
{
|
|
match: /({(?=.+?function (\i).{0,160}(\i)=\i\.useMemo.{0,140}return \i\.useMemo\(\(\)=>\i\(\3).+?\(\)=>)\2/,
|
|
replace: (_, rest, settingsHook) =>
|
|
`${rest}$self.wrapSettingsHook(${settingsHook})`,
|
|
},
|
|
],
|
|
},
|
|
// Fix the settings cog context menu to work properly
|
|
{
|
|
find: "#{intl::USER_SETTINGS_ACTIONS_MENU_LABEL}",
|
|
replacement: {
|
|
// Skip the check Discord performs to make sure the section being selected in the user settings context menu is valid
|
|
match: /(?<=function\((\i),(\i),\i\)\{)(?=let \i=Object.values\(\i\.\i\).+?(\(0,\i\.openUserSettings\))\()/,
|
|
replace: (_, settingsPanel, section, openUserSettings) => `${openUserSettings}(${settingsPanel},{section:${section}});return;`
|
|
}
|
|
},
|
|
{
|
|
find: ".buildLayout().map",
|
|
replacement: {
|
|
match: /(\i)\.buildLayout\(\)(?=\.map)/,
|
|
replace: "$self.buildLayout($1)"
|
|
}
|
|
}
|
|
],
|
|
|
|
buildLayout(originalLayoutBuilder: SettingsLayoutBuilder) {
|
|
const layout = originalLayoutBuilder.buildLayout();
|
|
if (originalLayoutBuilder.key !== "$Root") return layout;
|
|
if (!Array.isArray(layout)) return layout;
|
|
|
|
if (layout.some(s => s?.key === "vencord_section")) return layout;
|
|
|
|
const vencordEntries: SettingsLayoutNode[] = [
|
|
buildEntry({
|
|
key: "vencord_main",
|
|
title: "Equicord",
|
|
panelTitle: "Equicord Settings",
|
|
Component: VencordTab,
|
|
Icon: MainSettingsIcon
|
|
}),
|
|
buildEntry({
|
|
key: "vencord_plugins",
|
|
title: "Plugins",
|
|
Component: PluginsTab,
|
|
Icon: PluginsIcon
|
|
}),
|
|
buildEntry({
|
|
key: "vencord_themes",
|
|
title: "Themes",
|
|
Component: ThemesTab,
|
|
Icon: PaintbrushIcon
|
|
}),
|
|
!IS_UPDATER_DISABLED && UpdaterTab && buildEntry({
|
|
key: "vencord_updater",
|
|
title: "Updater",
|
|
panelTitle: "Equicord Updater",
|
|
Component: UpdaterTab,
|
|
Icon: UpdaterIcon
|
|
}),
|
|
buildEntry({
|
|
key: "vencord_cloud",
|
|
title: "Cloud",
|
|
panelTitle: "Equicord Cloud",
|
|
Component: CloudTab,
|
|
Icon: CloudIcon
|
|
}),
|
|
buildEntry({
|
|
key: "vencord_backup_restore",
|
|
title: "Backup & Restore",
|
|
Component: BackupAndRestoreTab,
|
|
Icon: BackupRestoreIcon
|
|
}),
|
|
IS_DEV && PatchHelperTab && buildEntry({
|
|
key: "vencord_patch_helper",
|
|
title: "Patch Helper",
|
|
Component: PatchHelperTab,
|
|
Icon: PatchHelperIcon
|
|
}),
|
|
...this.customEntries.map(buildEntry),
|
|
// TODO: Remove deprecated customSections in a future update
|
|
...this.customSections.map((func, i) => {
|
|
const { section, element, label } = func(FallbackSectionTypes);
|
|
if (Object.values(FallbackSectionTypes).includes(section)) return null;
|
|
|
|
return buildEntry({
|
|
key: `vencord_deprecated_custom_${section}`,
|
|
title: label,
|
|
Component: element,
|
|
Icon: section === "Vesktop" ? VesktopSettingsIcon : PlaceholderIcon
|
|
});
|
|
})
|
|
].filter(isTruthy);
|
|
|
|
const vencordSection: SettingsLayoutNode = {
|
|
key: "vencord_section",
|
|
type: LayoutTypes.SECTION,
|
|
useLabel: () => "Vencord",
|
|
buildLayout: () => vencordEntries
|
|
};
|
|
|
|
const { settingsLocation } = settings.store;
|
|
|
|
const places: Record<SettingsLocation, string> = {
|
|
top: "user_section",
|
|
aboveNitro: "billing_section",
|
|
belowNitro: "billing_section",
|
|
aboveActivity: "activity_section",
|
|
belowActivity: "activity_section",
|
|
bottom: "logout_section"
|
|
};
|
|
|
|
const key = places[settingsLocation] ?? places.top;
|
|
let idx = layout.findIndex(s => typeof s?.key === "string" && s.key === key);
|
|
|
|
if (idx === -1) {
|
|
idx = 2;
|
|
} else if (settingsLocation.startsWith("below")) {
|
|
idx += 1;
|
|
}
|
|
|
|
layout.splice(idx, 0, vencordSection);
|
|
|
|
return layout;
|
|
},
|
|
|
|
/** @deprecated Use customEntries */
|
|
customSections: [] as ((SectionTypes: SectionTypes) => any)[],
|
|
customEntries: [] as EntryOptions[],
|
|
|
|
makeSettingsCategories(SectionTypes: SectionTypes) {
|
|
return [
|
|
{
|
|
section: SectionTypes.HEADER,
|
|
label: "Equicord",
|
|
className: "vc-settings-header",
|
|
},
|
|
{
|
|
section: "EquicordSettings",
|
|
label: "Equicord",
|
|
element: VencordTab,
|
|
className: "vc-settings",
|
|
},
|
|
{
|
|
section: "EquicordPlugins",
|
|
label: "Plugins",
|
|
searchableTitles: ["Plugins"],
|
|
element: PluginsTab,
|
|
className: "vc-plugins",
|
|
},
|
|
{
|
|
section: "EquicordThemes",
|
|
label: "Themes",
|
|
searchableTitles: ["Themes"],
|
|
element: ThemesTab,
|
|
className: "vc-themes",
|
|
},
|
|
!IS_UPDATER_DISABLED && {
|
|
section: "EquicordUpdater",
|
|
label: "Updater",
|
|
searchableTitles: ["Updater"],
|
|
element: UpdaterTab,
|
|
className: "vc-updater",
|
|
},
|
|
{
|
|
section: "EquicordChangelog",
|
|
label: "Changelog",
|
|
searchableTitles: ["Changelog"],
|
|
element: ChangelogTab,
|
|
className: "vc-changelog",
|
|
},
|
|
{
|
|
section: "EquicordCloud",
|
|
label: "Cloud",
|
|
searchableTitles: ["Cloud"],
|
|
element: CloudTab,
|
|
className: "vc-cloud",
|
|
},
|
|
{
|
|
section: "settings/tabsSync",
|
|
label: "Backup & Restore",
|
|
searchableTitles: ["Backup & Restore"],
|
|
element: BackupAndRestoreTab,
|
|
className: "vc-backup-restore",
|
|
},
|
|
IS_DEV && {
|
|
section: "EquicordPatchHelper",
|
|
label: "Patch Helper",
|
|
searchableTitles: ["Patch Helper"],
|
|
element: PatchHelperTab,
|
|
className: "vc-patch-helper",
|
|
},
|
|
...this.customSections.map(func => func(SectionTypes)),
|
|
{
|
|
section: SectionTypes.DIVIDER,
|
|
},
|
|
].filter(Boolean);
|
|
},
|
|
|
|
isRightSpot({ header, settings: s }: { header?: string; settings?: string[]; }) {
|
|
const firstChild = s?.[0];
|
|
// lowest two elements... sanity backup
|
|
if (firstChild === "LOGOUT" || firstChild === "SOCIAL_LINKS")
|
|
return true;
|
|
|
|
const { settingsLocation } = settings.store;
|
|
|
|
if (settingsLocation === "bottom") return firstChild === "LOGOUT";
|
|
if (settingsLocation === "belowActivity")
|
|
return firstChild === "CHANGELOG";
|
|
|
|
if (!header) return;
|
|
|
|
try {
|
|
const names: Record<Exclude<SettingsLocation, "bottom" | "belowActivity">, string> = {
|
|
top: getIntlMessage("USER_SETTINGS"),
|
|
aboveNitro: getIntlMessage("BILLING_SETTINGS"),
|
|
belowNitro: getIntlMessage("APP_SETTINGS"),
|
|
aboveActivity: getIntlMessage("ACTIVITY_SETTINGS"),
|
|
};
|
|
|
|
if (
|
|
!names[settingsLocation] ||
|
|
names[settingsLocation].endsWith("_SETTINGS")
|
|
)
|
|
return firstChild === "PREMIUM";
|
|
|
|
return header === names[settingsLocation];
|
|
} catch {
|
|
return firstChild === "PREMIUM";
|
|
}
|
|
},
|
|
|
|
patchedSettings: new WeakSet(),
|
|
|
|
addSettings(
|
|
elements: any[],
|
|
element: { header?: string; settings: string[]; },
|
|
sectionTypes: SectionTypes,
|
|
) {
|
|
if (this.patchedSettings.has(elements) || !this.isRightSpot(element))
|
|
return;
|
|
|
|
this.patchedSettings.add(elements);
|
|
|
|
elements.push(...this.makeSettingsCategories(sectionTypes));
|
|
},
|
|
|
|
wrapSettingsHook(
|
|
originalHook: (...args: any[]) => Record<string, unknown>[],
|
|
) {
|
|
return (...args: any[]) => {
|
|
const elements = originalHook(...args);
|
|
if (!this.patchedSettings.has(elements))
|
|
elements.unshift(...this.makeSettingsCategories(FallbackSectionTypes));
|
|
|
|
return elements;
|
|
};
|
|
},
|
|
|
|
get electronVersion() {
|
|
return (
|
|
VencordNative.native.getVersions().electron ||
|
|
window.legcord?.electron ||
|
|
null
|
|
);
|
|
},
|
|
|
|
get chromiumVersion() {
|
|
try {
|
|
return (
|
|
VencordNative.native.getVersions().chrome ||
|
|
// @ts-expect-error Typescript will add userAgentData IMMEDIATELY
|
|
navigator.userAgentData?.brands?.find(
|
|
b =>
|
|
b.brand === "Chromium" || b.brand === "Google Chrome",
|
|
)?.version ||
|
|
null
|
|
);
|
|
} catch {
|
|
// inb4 some stupid browser throws unsupported error for navigator.userAgentData, it's only in chromium
|
|
return null;
|
|
}
|
|
},
|
|
|
|
getVersionInfo(support = true) {
|
|
let version = "";
|
|
|
|
if (IS_DEV) version = "Dev";
|
|
if (IS_WEB) version = "Web";
|
|
if (IS_VESKTOP) version = `Vesktop v${VesktopNative.app.getVersion()}`;
|
|
if (IS_EQUIBOP) version = `Equibop v${VesktopNative.app.getVersion()}`;
|
|
if (IS_STANDALONE) version = "Standalone";
|
|
|
|
return support && version ? ` (${version})` : version;
|
|
},
|
|
|
|
getInfoRows() {
|
|
const { electronVersion, chromiumVersion, getVersionInfo } = this;
|
|
|
|
const rows = [`Equicord ${gitHashShort}${getVersionInfo()}`];
|
|
|
|
if (electronVersion) rows.push(`Electron ${electronVersion}`);
|
|
if (chromiumVersion) rows.push(`Chromium ${chromiumVersion}`);
|
|
|
|
return rows;
|
|
},
|
|
|
|
getInfoString() {
|
|
return "\n" + this.getInfoRows().join("\n");
|
|
},
|
|
|
|
makeInfoElements(
|
|
Component: ComponentType<React.PropsWithChildren>,
|
|
props: PropsWithChildren,
|
|
) {
|
|
return this.getInfoRows().map((text, i) => (
|
|
<Component key={i} {...props}>
|
|
{text}
|
|
</Component>
|
|
));
|
|
},
|
|
});
|