Merge 1065fcb8ca into a318f6b407
This commit is contained in:
Tiagoquix
GitHub
commit
52a5517cb0
1 changed files with 51 additions and 22 deletions
73
README.md
73
README.md
|
|
@ -1,47 +1,68 @@
|
|||
# Vesktop
|
||||
|
||||
Vesktop is a custom Discord desktop app
|
||||
<img align="right" width="64" src="static/shiggy.gif">
|
||||
<img align="right" width="64" src="https://avatars.githubusercontent.com/u/113042587">
|
||||
|
||||
**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
|
||||
Vesktop is a custom Discord Desktop app.
|
||||
|
||||
**Not yet supported**:
|
||||
- Global Keybinds
|
||||
- see the [Roadmap](https://github.com/Vencord/Vesktop/issues/324)
|
||||
## Main features
|
||||
|
||||
|
||||
|
||||
- Vencord pre-installed.
|
||||
- Much more lightweight and faster than the official Discord app.
|
||||
- Linux screenshare with sound and Wayland compatibility.
|
||||
- Much better privacy, since Discord has no access to your system.
|
||||
- Fixes scroll issues and other issues/nuisances present on the official Discord app for Linux.
|
||||
|
||||
### Not yet supported
|
||||
|
||||
- Global keybinds.
|
||||
- For other things, see the [roadmap](https://github.com/Vencord/Vesktop/issues/324).
|
||||
|
||||
## Screenshots
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th colspan="3">Linux Screenshare</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://github.com/Vencord/Vesktop/assets/37805707/2f8259b7-f9e6-47c4-b801-dacbef30027a"/></td>
|
||||
<td><img src="https://github.com/Vencord/Vesktop/assets/37805707/4d1e1136-b7ac-4db5-afaf-0f8e425157db"/></td>
|
||||
<td><img src="https://github.com/Vencord/Vesktop/assets/37805707/536a4275-eb37-46a3-8f24-cf351e5ef10e"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Installing
|
||||
|
||||
### Windows
|
||||
|
||||
If you don't know the difference, pick the Installer.
|
||||
We recommend the installer.
|
||||
|
||||
- [Installer](https://vencord.dev/download/vesktop/universal/windows)
|
||||
- Portable:
|
||||
- [x64 / amd64](https://vencord.dev/download/vesktop/amd64/windows-portable)
|
||||
- [arm64](https://vencord.dev/download/vesktop/arm64/windows-portable)
|
||||
|
||||
### Mac
|
||||
### MacOS
|
||||
|
||||
[Vesktop.dmg](https://vencord.dev/download/vesktop/universal/dmg)
|
||||
|
||||
### Linux
|
||||
|
||||
Flathub provides both `amd64` (`x86_64`) and `arm64` (`aarch64`) builds on a single standalone.
|
||||
|
||||
[](https://flathub.org/apps/dev.vencord.Vesktop)
|
||||
|
||||
If you don't know the difference, pick amd64.
|
||||
If you prefer a native package for your distribution, check the list below.
|
||||
|
||||
- amd64 / x86_64
|
||||
To check which version is appropriate for your system, type `uname -m` in a terminal window.
|
||||
|
||||
- `amd64` (`x86_64`)
|
||||
- [AppImage](https://vencord.dev/download/vesktop/amd64/appimage)
|
||||
- [Ubuntu/Debian (.deb)](https://vencord.dev/download/vesktop/amd64/deb)
|
||||
- [Fedora/RHEL (.rpm)](https://vencord.dev/download/vesktop/amd64/rpm)
|
||||
- [tarball](https://vencord.dev/download/vesktop/amd64/tar)
|
||||
- arm64 / aarch64
|
||||
|
||||
- `arm64` (`aarch64`)
|
||||
- [AppImage](https://vencord.dev/download/vesktop/arm64/appimage)
|
||||
- [Ubuntu/Debian (.deb)](https://vencord.dev/download/vesktop/arm64/deb)
|
||||
- [Fedora/RHEL (.rpm)](https://vencord.dev/download/vesktop/arm64/rpm)
|
||||
|
|
@ -49,21 +70,23 @@ If you don't know the difference, pick amd64.
|
|||
|
||||
#### Community packages
|
||||
|
||||
Below you can find unofficial packages created by the community. They are not officially supported by us, so before reporting issues, please first confirm the issue also happens on official builds. When in doubt, consult with their packager first. The flatpak and AppImage should work on any distro that [supports them](https://flatpak.org/setup/), so I recommend you just use those instead!
|
||||
> [!NOTE]
|
||||
> There are unofficial packages created by the community. They are not officially supported by us; so, before reporting issues, please first confirm the issue also happens on official builds. When in doubt, consult with their packager first.
|
||||
> The Flatpak and AppImage should work on any distro that [supports them](https://flatpak.org/setup/), so I recommend you just use those instead!
|
||||
|
||||
- Arch Linux: [Vesktop on the Arch user repository](https://aur.archlinux.org/packages?K=vesktop)
|
||||
- Arch Linux: [Vesktop on the Arch User Repository (AUR)](https://aur.archlinux.org/packages?K=vesktop)
|
||||
- NixOS: https://wiki.nixos.org/wiki/Discord#Vesktop
|
||||
- Windows - Scoop: https://scoop.sh/#/apps?q=Vesktop
|
||||
- Windows (via Scoop): https://scoop.sh/#/apps?q=Vesktop
|
||||
|
||||
## Building from Source
|
||||
## Building from source
|
||||
|
||||
Packaging will create builds in the dist/ folder
|
||||
Packaging will create builds in the <kdb>dist/</kbd> folder
|
||||
|
||||
```sh
|
||||
git clone https://github.com/Vencord/Vesktop
|
||||
cd Vesktop
|
||||
|
||||
# Install Dependencies
|
||||
# Install dependencies
|
||||
pnpm i
|
||||
|
||||
# Either run it without packaging
|
||||
|
|
@ -76,3 +99,9 @@ pnpm package --linux pacman
|
|||
# Or package to a directory only
|
||||
pnpm package:dir
|
||||
```
|
||||
|
||||
# Licensing
|
||||
|
||||
This project is licensed under the GNU General Public License (GPL) version 3, or, at your option, any later version.
|
||||
|
||||
See the [<kdb>LICENSE</kbd>](LICENSE) file for more details.
|
||||
|
|
|
|||
Reference in a new issue