Files
Vesktop/README.md

60 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2023-07-13 19:03:13 +02:00
# Vesktop
2023-03-30 01:02:30 +02:00
2024-01-19 03:38:15 +01:00
Vesktop is a custom Discord desktop app
2023-04-04 03:35:31 +02:00
2024-01-19 03:38:15 +01:00
**Main features**:
- Vencord preinstalled
- Much more lightweight and faster than the official Discord app
- Linux Screenshare with sound & wayland
- Much better privacy, since Discord has no access to your system
2023-05-05 01:29:24 +02:00
2024-01-19 03:38:15 +01:00
**Not yet supported**:
- Global Keybinds
- see the [Roadmap](https://github.com/Vencord/Vesktop/issues/324)
2023-04-28 02:38:59 +02:00
2023-12-02 14:54:54 +01:00
![](https://github.com/Vencord/Vesktop/assets/45497981/8608a899-96a9-4027-9725-2cb02ba189fd)
2024-01-19 03:38:15 +01:00
![](https://github.com/Vencord/Vesktop/assets/45497981/8701e5de-52c4-4346-a990-719cb971642e)
2023-12-02 14:54:54 +01:00
2023-04-04 03:35:31 +02:00
## Installing
Visit https://vesktop.dev/install
2023-04-04 03:35:31 +02:00
2024-01-19 03:38:15 +01:00
## Building from Source
2023-04-04 03:35:31 +02:00
2025-03-27 00:20:29 +01:00
You need to have the following dependencies installed:
- [Git](https://git-scm.com/downloads)
- [Node.js](https://nodejs.org/en/download)
- pnpm: `npm install --global pnpm`
2024-01-19 03:38:15 +01:00
Packaging will create builds in the dist/ folder
2023-04-04 03:35:31 +02:00
```sh
2023-07-13 19:03:13 +02:00
git clone https://github.com/Vencord/Vesktop
cd Vesktop
2023-04-04 03:35:31 +02:00
# Install Dependencies
pnpm i
# Either run it without packaging
pnpm start
2025-03-27 00:20:29 +01:00
# Or package (will build packages for your OS)
2023-04-04 03:35:31 +02:00
pnpm package
2025-03-27 00:20:29 +01:00
# Or only build the Linux Pacman package
2023-04-09 00:49:47 +02:00
pnpm package --linux pacman
2025-03-27 00:20:29 +01:00
2023-04-04 03:35:31 +02:00
# Or package to a directory only
pnpm package:dir
```
## Building LibVesktop from Source
This is a small C++ helper library Vesktop uses on Linux to emit D-Bus events. By default, prebuilt binaries for x64 and arm64 are used.
If you want to build it from source:
1. Install build dependencies:
- Debian/Ubuntu: `apt install build-essential python3 curl pkg-config libglib2.0-dev`
- Fedora: `dnf install @c-development @development-tools python3 curl pkgconf-pkg-config glib2-devel`
2. Run `pnpm buildLibVesktop`
3. From now on, building Vesktop will use your own build