From 371b5b0be8a6a6fab64ecb2d03c760f85820a063 Mon Sep 17 00:00:00 2001 From: V Date: Wed, 22 Nov 2023 06:14:16 +0100 Subject: [PATCH] allow plugins to specify how soon their start() method is called --- src/Vencord.ts | 16 +++++++++++----- src/plugins/clientTheme/index.tsx | 22 +++++----------------- src/plugins/index.ts | 10 ++++++++-- src/utils/types.ts | 14 ++++++++++++++ 4 files changed, 38 insertions(+), 24 deletions(-) diff --git a/src/Vencord.ts b/src/Vencord.ts index 83c69e73..a106a0b7 100644 --- a/src/Vencord.ts +++ b/src/Vencord.ts @@ -27,6 +27,8 @@ export { PlainSettings, Settings }; import "./utils/quickCss"; import "./webpack/patchWebpack"; +import { StartAt } from "@utils/types"; + import { get as dsGet } from "./api/DataStore"; import { showNotification } from "./api/Notifications"; import { PlainSettings, Settings } from "./api/Settings"; @@ -79,7 +81,7 @@ async function syncSettings() { async function init() { await onceReady; - startAllPlugins(); + startAllPlugins(StartAt.WebpackReady); syncSettings(); @@ -130,13 +132,17 @@ async function init() { } } +startAllPlugins(StartAt.Init); init(); -if (IS_DISCORD_DESKTOP && Settings.winNativeTitleBar && navigator.platform.toLowerCase().startsWith("win")) { - document.addEventListener("DOMContentLoaded", () => { +document.addEventListener("DOMContentLoaded", () => { + startAllPlugins(StartAt.DOMContentLoaded); + + if (IS_DISCORD_DESKTOP && Settings.winNativeTitleBar && navigator.platform.toLowerCase().startsWith("win")) { document.head.append(Object.assign(document.createElement("style"), { id: "vencord-native-titlebar-style", textContent: "[class*=titleBar]{display: none!important}" })); - }, { once: true }); -} + } +}, { once: true }); + diff --git a/src/plugins/clientTheme/index.tsx b/src/plugins/clientTheme/index.tsx index d0026c75..7cda33e2 100644 --- a/src/plugins/clientTheme/index.tsx +++ b/src/plugins/clientTheme/index.tsx @@ -12,7 +12,7 @@ import { getTheme, Theme } from "@utils/discord"; import { Margins } from "@utils/margins"; import { classes } from "@utils/misc"; import { LazyComponent } from "@utils/react"; -import definePlugin, { OptionType } from "@utils/types"; +import definePlugin, { OptionType, StartAt } from "@utils/types"; import { findByCode } from "@webpack"; import { Button, Forms } from "@webpack/common"; @@ -87,25 +87,13 @@ export default definePlugin({ description: "Recreation of the old client theme experiment. Add a color to your Discord client theme", settings, - patches: [ - { - find: "Could not find app-mount", - replacement: { - match: /(?<=Could not find app-mount"\))/, - replace: ",$self.addThemeInitializer()" - } - } - ], - - addThemeInitializer() { - document.addEventListener("DOMContentLoaded", this.themeInitializer = () => { - updateColorVars(settings.store.color); - generateColorOffsets(); - }); + startAt: StartAt.DOMContentLoaded, + start() { + updateColorVars(settings.store.color); + generateColorOffsets(); }, stop() { - document.removeEventListener("DOMContentLoaded", this.themeInitializer); document.getElementById("clientThemeVars")?.remove(); document.getElementById("clientThemeOffsets")?.remove(); } diff --git a/src/plugins/index.ts b/src/plugins/index.ts index f6d57726..23483860 100644 --- a/src/plugins/index.ts +++ b/src/plugins/index.ts @@ -19,7 +19,7 @@ import { registerCommand, unregisterCommand } from "@api/Commands"; import { Settings } from "@api/Settings"; import { Logger } from "@utils/Logger"; -import { Patch, Plugin } from "@utils/types"; +import { Patch, Plugin, StartAt } from "@utils/types"; import { FluxDispatcher } from "@webpack/common"; import { FluxEvents } from "@webpack/types"; @@ -85,9 +85,15 @@ for (const p of pluginsValues) { } } -export const startAllPlugins = traceFunction("startAllPlugins", function startAllPlugins() { +export const startAllPlugins = traceFunction("startAllPlugins", function startAllPlugins(target: StartAt) { + logger.info(`Starting plugins (stage ${target})`); for (const name in Plugins) if (isPluginEnabled(name)) { + const p = Plugins[name]; + + const startAt = p.startAt ?? StartAt.WebpackReady; + if (startAt !== target) continue; + startPlugin(Plugins[name]); } }); diff --git a/src/utils/types.ts b/src/utils/types.ts index b32b127b..7305cd01 100644 --- a/src/utils/types.ts +++ b/src/utils/types.ts @@ -80,6 +80,11 @@ export interface PluginDef { * Whether this plugin should be enabled by default, but can be disabled */ enabledByDefault?: boolean; + /** + * When to call the start() method + * @default StartAt.WebpackReady + */ + startAt?: StartAt, /** * Optionally provide settings that the user can configure in the Plugins tab of settings. * @deprecated Use `settings` instead @@ -117,6 +122,15 @@ export interface PluginDef { tags?: string[]; } +export const enum StartAt { + /** Right away, as soon as Vencord initialised */ + Init = "Init", + /** On the DOMContentLoaded event, so once the document is ready */ + DOMContentLoaded = "DOMContentLoaded", + /** Once Discord's core webpack modules have finished loading, so as soon as things like react and flux are available */ + WebpackReady = "WebpackReady" +} + export const enum OptionType { STRING, NUMBER,