readme.md

September 23, 2024 ยท View on GitHub

License: MIT GitHub Tag GitHub issues Discord GitHub language count

Warning

VX is currently in development and is not fully released. Installation methods may be unstable, with the Microsoft Edge Store being the only currently supported option: MS Edge Store.

VX Overview

VX is a lightweight client modification for Discord, compatible with both the desktop application and web browser versions.

Installation Guide

Desktop Application

Currently, VX does not support a reliable installation method on the Discord desktop app.

There will be an installation method here shortly

Browser Extension

Microsoft Edge Logo

Caution

Be aware of potential high memory and CPU usage, which can cause Discord to crash or reload unexpectedly. This issue is likely related to Microsoft Edge rather than VX itself, as opening DevTools in Edge can also trigger increased resource consumption.

Key Features

  • 50+ Built-In Plugins: Each plugin offers unique functionality with the option to load custom plugins.
  • Theming Support: Easily customize the look and feel of your Discord client.
  • Content Protection Mode: Enable enhanced security features for Electron-based apps (available on macOS and Windows only).

Why VX?

VX provides a lightweight, versatile solution for enhancing your Discord experience, whether on the desktop app or in a web browser.

Suggesting New Plugins

To suggest new plugins, please create a new issue and ensure your suggestion is not already listed.

Contributing to VX

Interested in adding features or plugins to VX? Here's how you can get involved:

  1. Prerequisites: Ensure you have Git and Node.js.

  2. Clone the Repository:

    git clone https://github.com/doggybootsy/vx

  3. Install Dependencies

    npm install

  4. Build VX

    npm run ./index.js

    • Use the following flags to specify the build type:

      -w or --web: Compile files for the web.

      -d or --desktop: Compile files for the desktop app.

      -a or --asar: Package desktop files into an .asar.

      -p or --production: Compile in production mode.

  5. Using the Compiled Build:

    • Desktop: Link the ./app folder generated by VX to yourdiscord-desktop-core (located in %localappdata%\discord\app-#.#.####\modules\discord_desktop_core-#\discord_desktop_core) or replace the app.asar in the resource folder (%localappdata%\discord\app-#.#.####\resources).
    • Web: Add the compiled files to your browser extension and reload. A dedicated extension module for VX is planned for the future.