project-client/README.md
2024-01-07 02:44:14 +01:00

2.3 KiB

Vesktop

Vesktop is a cross platform desktop app aiming to give you a snappier Discord experience with Vencord pre-installed

Not yet supported:

  • Global Keybinds

Bug reports, feature requests & contributions are highly appreciated!!

grafik

Installing

Windows

Download and run Vesktop-Setup-VERSION.exe from releases

Mac

Download and run Vesktop-VERSION.dmg from releases

Linux

Arch based

Install vencord-desktop-git from the AUR using your favourite AUR helper, for example yay

Ubuntu/Debian based

Download Vesktop-VERSION.deb from releases

Fedora/RHEL based

Download Vesktop-VERSION.rpm from releases

Other

Either download Vesktop-VERSION.AppImage and just run it directly or grab Vesktop-VERSION.tar.gz, extract it somewhere and run vesktop.

If other packages are created, feel free to open an issue and we'll link them here.

Building

Packaging will create builds in the dist/ folder. You can then install them like mentioned above or distribute them

git clone https://github.com/Vencord/Vesktop
cd Vesktop

# Install Dependencies
pnpm i

# Either run it without packaging
pnpm start

# Or package
pnpm package
# Or only build the pacman target
pnpm package --linux pacman
# Or package to a directory only
pnpm package:dir

Motivation

The official Discord Desktop app is very resource heavy compared to Discord in your Browser. There are multiple alternative Electron apps (ArmCord, WebCord, probably more) that prove how much of a performance gain you can gain by using a custom app. ArmCord already supports Vencord but makes it pretty limited for us. Making our own standalone app gives us much more control.