website·Indexed 33 days ago
https://guide.replugged.devDocumentation for developing addons, plugins, and themes for Replugged. Includes guides on using Webpack modules, common components like TextArea and Tooltip, plugin settings, manifest configuration, and the Replugged Addon Store released in v4.3.0.
InviteSuggestion type provides metadata about an invite suggestion, including whether it is filtered and the total number of available suggestions.interface InviteSuggestion {
isAffinitySuggestion: boolean;
isFiltered: boolean;
numAffinityConnections: number;
numTotal: number;
rowNum: number;
}open or openLazy, the function receives ContextMenuProps. These props provide metadata about the menu's environment, including the target HTMLElement, the current theme, and the context (defaults to 'APP').interface ContextMenuProps {
className: string;
config: ContextMenusOptions;
context: string; // default: 'APP'
onHeightUpdate: () => void;
position: Tooltip.Positions;
target: HTMLElement;
theme: string;
}getState() to retrieve a State object containing information about guild selections, including the current and last selected guild IDs and a record of selection timestamps.const state = guildsStore.getState();
console.log(state.selectedGuildId); // Current selected guild id
console.log(state.lastSelectedGuildId); // Last selected guild id
console.log(state.selectedGuildTimestampMillis); // Record<string, number> of timestampsgetFunctionBySource returns the function itself, while getFunctionKeyBySource returns the property name (key), which is required for using the Injector.import { Injector, webpack } from "replugged";
const { getBySource, getFunctionBySource, getFunctionKeyBySource } = webpack;
const injector = new Injector();
export function start() {
const module = getBySource("YOUR QUERY HERE");
// Get the function directly
const functionInModule = getFunctionBySource(module, "YOUR QUERY HERE");
// Get the key for injection
const keyInModule = getFunctionKeyBySource(module, "YOUR QUERY HERE");
injector.after(module, keyInModule, (args, res) => {
console.log("Function was called!", { args, res });
});
}You can create a direct installation link that prompts users to install your theme in Replugged using the format: https://replugged.dev/install?identifier={identifier}&source={source}.
Parameters:
identifier: Must match the updater.id in the manifest.source: Must match updater.source in the manifest (currently supports github or store).id: (Optional) Required only if the update source is GitHub and the release contains multiple themes. Matches the id in the manifest.[](https://replugged.dev/install?identifier=YOUR_ADDON_INFO_HERE&source=github)Use the watch script to automatically rebuild the plugin when changes are detected. By default, this will also reload the plugin within Discord.
pnpm run watch.--no-reload flag if you want to rebuild without automatically reloading in Discord.Ctrl + R).pnpm run watch
# Or to disable auto-reload
pnpm run watch --no-reloadpnpm install
pnpm startcommon object. When developing plugins, always import from the main replugged package and destructure the required module. Avoid importing directly from internal paths like replugged/dist/... as they will not function correctly. For debugging or testing in Discord DevTools, these modules are available via the global replugged.common object.import { common } from "replugged";To develop plugins for Replugged, you need the following technical stack and tools:
src/index.ts) must export two functions: start and stop. All injection logic should be initialized within start, and all injections must be cleaned up within stop to prevent memory leaks or unexpected behavior.common export from the replugged package. When importing, you must destructure the desired module from the main replugged entry point. Do not import modules directly from internal paths like replugged/dist/... as they will not function correctly.import { common } from "replugged";