armcord/README.md

103 lines
4.3 KiB
Markdown
Raw Normal View History

2022-01-15 21:21:51 +00:00
2022-01-17 12:13:10 +00:00
<div align="center">
2022-07-07 20:36:09 +00:00
<img src="https://armcord.xyz/logo.png" width="520">
2022-07-09 22:46:17 +00:00
<br>ArmCord is a custom client designed to enhance your Discord experience while keeping everything lightweight.
2022-01-17 12:13:10 +00:00
</div>
2022-01-15 21:21:51 +00:00
# Features
2021-05-01 17:53:38 +00:00
2022-01-17 12:13:10 +00:00
- **Standalone client**
2022-07-07 19:31:29 +00:00
ArmCord is built as a standalone client and doesn't rely on the original Discord client in anyway.
2022-01-17 12:13:10 +00:00
- **Various mods built in**
2022-11-19 22:15:05 +00:00
Enjoy Vencord, Shelter and their many features, or have a more vanilla experience, it's your choice!
2022-01-17 12:13:10 +00:00
2022-07-07 19:31:29 +00:00
- **Made for Privacy™**
2022-01-17 12:13:10 +00:00
2022-07-07 19:31:29 +00:00
ArmCord automatically blocks all of Discord's trackers; even without any client mods you can feel safe and secure!
2022-01-17 12:13:10 +00:00
2022-07-07 19:31:29 +00:00
- **Much more stable**
2022-01-17 12:13:10 +00:00
2022-07-07 19:31:29 +00:00
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.
2022-01-17 12:13:10 +00:00
2022-07-07 19:31:29 +00:00
- **Cross-platform support!**
2022-01-17 12:13:10 +00:00
2022-07-07 19:31:29 +00:00
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)!
2022-01-17 12:13:10 +00:00
2021-03-20 19:07:15 +00:00
# How to run/install it?
2022-01-15 21:21:51 +00:00
### Recommended:
2022-04-20 18:43:38 +00:00
Check releases tab for precompiled packages for Linux, Windows and Mac OS. Alternatively use our Sourceforge mirror.
2022-02-07 17:25:47 +00:00
<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
```
2022-09-27 13:31:04 +00:00
### Scoop package
ArmCord is also available on [Scoop extras](https://github.com/ScoopInstaller/Extras) repo:
```
scoop bucket add extras
```
```
scoop install armcord
```
2022-01-17 13:55:16 +00:00
### AUR Package
2022-05-21 10:11:55 +00:00
ArmCord is also available on the Arch User Repository (AUR) [here](https://aur.archlinux.org/packages/armcord-bin/).
2022-01-17 13:55:16 +00:00
Install it via an AUR helper tool like `yay`.
**Example:** `yay -S armcord-bin`
2022-05-21 10:11:55 +00:00
### 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>
2022-06-21 21:50:12 +00:00
### Pi-Apps
ArmCord is also available in [Pi-Apps](https://github.com/Botspot/pi-apps).
[![badge](https://github.com/Botspot/pi-apps/blob/master/icons/badge.png?raw=true)](https://github.com/Botspot/pi-apps)
2022-07-07 19:31:29 +00:00
### Compiling:
2022-10-08 15:43:08 +00:00
Alternatively you can run ArmCord from source (NodeJS and pnpm required):
2022-01-17 12:15:16 +00:00
1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`
2022-10-08 15:43:08 +00:00
2. Run `pnpm install` to install dependencies
2022-05-21 10:17:28 +00:00
3. Build with `npm run build`
4. Compile/Package with `npm run package`
2021-05-01 17:08:41 +00:00
2021-05-01 12:48:50 +00:00
2020-11-16 13:59:19 +00:00
# FAQ
2022-07-07 19:31:29 +00:00
## 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!
2021-05-01 13:46:53 +00:00
2022-07-07 19:31:29 +00:00
## Where can I find the source code?
- The source code is on [GitHub](https://github.com/ArmCord/ArmCord/).
2021-05-01 13:46:53 +00:00
2022-07-07 19:31:29 +00:00
## 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).
2021-05-01 17:08:41 +00:00
2021-05-04 10:18:49 +00:00
# Credits
2022-07-07 19:31:29 +00:00
[ArmCord UI design, branding, and a few features](https://github.com/kckarnige)
2021-11-01 20:48:21 +00:00
[Cumcord](https://github.com/Cumcord/Cumcord)
2022-07-07 19:31:29 +00:00
[GooseMod](https://github.com/GooseMod/GooseMod)
[GooseMod Extension](https://github.com/GooseMod/extension)
[FlickerMod](https://github.com/FlickerMod)
2021-05-04 10:20:10 +00:00
[electron-discord-webapp](https://github.com/SpacingBat3/electron-discord-webapp)
2022-07-07 19:31:29 +00:00
(Pre v3.0.6) [custom-electron-titlebar](https://github.com/AlexTorresSk/custom-electron-titlebar)
[electron-builder](https://electron.build)
[OpenAsar](https://github.com/GooseMod/OpenAsar)
2022-05-13 13:17:29 +00:00
# Sponsors
[![JetBrains supports ArmCord with free licenses to their software to core developers](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://jb.gg/OpenSourceSupport)