mirror of
https://github.com/smartfrigde/armcord.git
synced 2024-08-14 23:56:58 +00:00
102 lines
4.4 KiB
Markdown
102 lines
4.4 KiB
Markdown
|
|
<div align="center">
|
|
<img src="https://armcord.xyz/logo.png" width="520">
|
|
<br>ArmCord is a custom client designed to enhance your Discord experience while keeping everything lightweight.
|
|
</div>
|
|
|
|
# Features
|
|
|
|
- **Standalone client**
|
|
|
|
ArmCord is built as a standalone client and doesn't rely on the original Discord client in anyway.
|
|
|
|
|
|
- **Various mods built in**
|
|
|
|
Enjoy Vencord, Shelter and their many features, or have a more vanilla experience, it's your choice!
|
|
|
|
|
|
- **Made for Privacy™**
|
|
|
|
ArmCord automatically blocks all of Discord's trackers; even without any client mods you can feel safe and secure!
|
|
|
|
|
|
- **Much more stable**
|
|
|
|
ArmCord is using a newer build of Electron than the stock Discord app. This means you can have a much more stable and secure experience, along with slightly better performance.
|
|
|
|
|
|
- **Cross-platform support!**
|
|
|
|
ArmCord was originally created for ARM64 Linux devices, since Discord doesn't support them. We soon decided to support every platform that [Electron supports](https://github.com/electron/electron#platform-support)!
|
|
|
|
# How to run/install it?
|
|
### Recommended:
|
|
Check releases tab for precompiled packages for Linux, Windows and Mac OS. Alternatively use our Sourceforge mirror.
|
|
<a href="https://sourceforge.net/projects/armcord/files/latest/download"><img alt="Download ArmCord" src="https://a.fsdn.com/con/app/sf-download-button" width=276 height=48 srcset="https://a.fsdn.com/con/app/sf-download-button?button_size=2x 2x"></a>
|
|
### Winget Package
|
|
ArmCord is also available on the [winget-pkgs](https://github.com/microsoft/winget-pkgs) repository:
|
|
```
|
|
winget install ArmCord.ArmCord
|
|
```
|
|
### Scoop package
|
|
ArmCord is also available on [Scoop extras](https://github.com/ScoopInstaller/Extras) repo:
|
|
```
|
|
scoop bucket add extras
|
|
```
|
|
```
|
|
scoop install armcord
|
|
```
|
|
### AUR Package
|
|
ArmCord is also available on the Arch User Repository (AUR):
|
|
- [armcord-bin](https://aur.archlinux.org/packages/armcord-bin) - ArmCord Release ~ Static binary from release, may be outdated
|
|
- [armcord-git](https://aur.archlinux.org/packages/armcord-git) - ArmCord Dev ~ Latest devbuild built from source (takes ~1 minute) using the system electron
|
|
|
|
Install it via an AUR helper tool like `yay`.
|
|
|
|
**Example:** `yay -S armcord-bin`
|
|
### Snap package
|
|
ArmCord is also available on the Snap store [here](https://snapcraft.io/armcord).
|
|
<a href="https://snapcraft.io/armcord">
|
|
<img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" />
|
|
</a>
|
|
### Pi-Apps
|
|
ArmCord is also available in [Pi-Apps](https://github.com/Botspot/pi-apps).
|
|
[](https://github.com/Botspot/pi-apps)
|
|
|
|
|
|
### Compiling:
|
|
Alternatively you can run ArmCord from source (NodeJS and pnpm required):
|
|
1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`
|
|
2. Run `pnpm install` to install dependencies
|
|
3. Build with `npm run build`
|
|
4. Compile/Package with `npm run package`
|
|
|
|
|
|
# FAQ
|
|
## Will I get banned for using this?
|
|
- You are breaking [Discord ToS](https://discord.com/terms#software-in-discord%E2%80%99s-services) by using ArmCord, but no one has been banned from using it or any of the client mods included.
|
|
|
|
## Can I use this on anything other than ARM?
|
|
- Yes! ArmCord should work normally under Windows, MacOS and Linux as long as it has Electron support.
|
|
|
|
## How does this work?
|
|
- We are using the official web app and adding some magic powder to make it all work!
|
|
|
|
## Where can I find the source code?
|
|
- The source code is on [GitHub](https://github.com/ArmCord/ArmCord/).
|
|
|
|
## Where can I translate this?
|
|
- Translations are done using our [Weblate page](https://hosted.weblate.org/projects/armcord/armcord/). They're pushed to this [repo](https://github.com/ArmCord/i18n).
|
|
|
|
# Credits
|
|
- [ArmCord UI design, branding, and a few features](https://github.com/kckarnige)
|
|
- [OpenAsar](https://github.com/GooseMod/OpenAsar)
|
|
- [arRPC (for Rich Presence)](https://github.com/OpenAsar/arrpc)
|
|
- (pre v3.1.0) [Cumcord](https://github.com/Cumcord/Cumcord)
|
|
- (pre v3.1.0) [GooseMod](https://github.com/GooseMod/GooseMod)
|
|
- (pre v3.1.0) [GooseMod Extension](https://github.com/GooseMod/extension)
|
|
- (pre v3.1.0) [FlickerMod](https://github.com/FlickerMod)
|
|
- (Pre v3.0.0) [custom-electron-titlebar](https://github.com/AlexTorresSk/custom-electron-titlebar)
|
|
- [electron-builder](https://electron.build)
|
|
|