project-client/README.md

71 lines
2.6 KiB
Markdown
Raw Normal View History

2023-07-13 17:03:13 +00:00
# Vesktop
2023-03-29 23:02:30 +00:00
2023-07-13 17:03:13 +00:00
Vesktop is a cross platform desktop app aiming to give you a snappier Discord experience with Vencord pre-installed
2023-04-04 01:35:31 +00:00
2023-05-04 23:30:11 +00:00
**Not yet supported**:
2023-05-04 23:29:24 +00:00
- Global Keybinds
Bug reports, feature requests & contributions are highly appreciated!!
2023-04-28 00:38:59 +00:00
2023-05-04 23:29:24 +00:00
![image](https://user-images.githubusercontent.com/45497981/235024615-94565eaf-f412-4384-a3f5-d8cde7458f6d.png)
2023-04-04 01:35:31 +00:00
## Installing
### Windows
2023-07-13 17:03:13 +00:00
Download and run Vesktop-Setup-VERSION.exe from [releases](https://github.com/Vencord/Vesktop/releases/latest)
2023-04-04 01:35:31 +00:00
### Mac
2023-07-13 17:03:13 +00:00
Download and run Vesktop-VERSION.dmg from [releases](https://github.com/Vencord/Vesktop/releases/latest)
2023-04-04 01:35:31 +00:00
### Linux
2023-04-09 02:35:04 +00:00
#### Arch based
2023-04-09 02:35:27 +00:00
Install [vencord-desktop-git](https://aur.archlinux.org/packages/vencord-desktop-git) from the AUR using your favourite AUR helper, for example [yay](https://github.com/Jguer/yay)
2023-04-09 02:35:04 +00:00
2023-04-04 01:35:31 +00:00
#### Ubuntu/Debian based
2023-07-13 17:03:13 +00:00
Download Vesktop-VERSION.deb from [releases](https://github.com/Vencord/Vesktop/releases/latest)
2023-04-04 01:35:31 +00:00
#### Fedora/RHEL based
2023-07-13 17:03:13 +00:00
Download Vesktop-VERSION.rpm from [releases](https://github.com/Vencord/Vesktop/releases/latest)
2023-04-04 01:35:31 +00:00
#### Other
2023-07-13 17:03:13 +00:00
Either download Vesktop-VERSION.AppImage and just run it directly or grab Vesktop-VERSION.tar.gz, extract it somewhere and run `vencorddesktop`.
2023-04-04 01:35:31 +00:00
2023-04-09 02:35:04 +00:00
A flatpak is planned, if you want packages for other repos, feel free to create them and they can be linked as unofficial here
2023-04-04 01:35:31 +00:00
## Building
Packaging will create builds in the dist/ folder. You can then install them like mentioned above or distribute them
```sh
2023-07-13 17:03:13 +00:00
git clone https://github.com/Vencord/Vesktop
cd Vesktop
2023-04-04 01:35:31 +00:00
# Install Dependencies
pnpm i
# Either run it without packaging
pnpm start
# Or package
pnpm package
2023-04-08 22:49:47 +00:00
# Or only build the pacman target
pnpm package --linux pacman
2023-04-04 01:35:31 +00:00
# Or package to a directory only
pnpm package:dir
```
2023-03-29 23:17:48 +00:00
## 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.
This is just a random idea I (V) got, and might not actually ever be finished heh
2023-03-31 07:36:28 +00:00
Gluon also seems very attractive for this because of how lightweight it can be and because unlike electron, streaming just works out of the box like in any chromium browser. However, at the time of writing this, it still lacks some features necessary to make it work (synchronous ipc or a way to get node process variables into the onLoad function for instance, plus onLoad seems to load a little too late sometimes)