smartfridge/armcord
1
1
Fork 0
mirror of https://github.com/smartfrigde/armcord.git synced 2024-08-14 23:56:58 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/armcord/armcord

Browse source
This commit is contained in:
smartfrigde 2022-01-17 15:35:14 +01:00
commit 5ab18f68b8
1 changed files with 43 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,35 +1,61 @@
<h1 align="center"> <div align="center">
<img src="https://armcord.vercel.app/armcord_full_logo.png" width="720"> <img src="https://armcord.vercel.app/armcord_full_logo.png" width="720">
</h1> <br>ArmCord is a custom client designed to enhance your Discord experience while keeping everything lightweight.
</div>
ArmCord is a custom client designed to enhance your Discord experience while keeping everything lightweight.
# Features # Features
* **Standalone client** - ArmCord is built as standalone client, it doesn't rely on original Discord client. - **Standalone client**
* **Various mods built in** - Explore Cumcord/GooseMod/Flicker plugins and their features!
* **Made for Privacy** - ArmCord automatically blocks Discord's trackers. ArmCord is built as standalone client, it doesn't rely on original Discord client.
* **Faster than normal Discord app** - ArmCord is using newer Electron than stock Discord app. This usually means increased performance and more stable experience.
* **Designed to work anywhere** - ArmCord was initially created in mind to run on Arm64 Linux devices. We soon expanded our support to more platforms. We plan to support every platform that [Electron supports](https://www.electronjs.org/docs/latest/tutorial/support#supported-platforms).
- **Various mods built in**
Explore Cumcord/GooseMod/Flicker plugins and their features!
- **Made for Privacy**
ArmCord automatically blocks Discord's trackers.
- **Faster than normal Discord app**
ArmCord is using newer Electron than stock Discord app. This usually means increased performance and more stable experience.
- **Designed to work anywhere**
ArmCord was initially created in mind to run on Arm64 Linux devices. We soon expanded our support to more platforms. We plan to support every platform that [Electron supports](https://www.electronjs.org/docs/latest/tutorial/support#supported-platforms).
# How to run/install it? # How to run/install it?
### Recommended: ### Recommended:
Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental). Check releases tab for precompiled packages for Linux, Windows and ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)).
### AUR Package
Armcord is also available on the Arch User Repository (AUR) [here](https://aur.archlinux.org/packages/armcord-bin/).
Install it via an AUR helper tool like `yay`.
**Example:** `yay -S armcord-bin`
### Manual: ### Manual:
Alternatively you can run ArmCord from source (npm, nodejs required): Alternatively you can run ArmCord from source (npm, nodejs required):
1.Clone ArmCord repo: `git clonehttps://github.com/ArmCord/ArmCord.git` 1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`
2.Run `npm install` to install dependencies 2. Run `npm install` to install dependencies
3.Compile/Package with `npm run package` 3. Compile/Package with `npm run package`
# FAQ # FAQ
## 1.Will I get banned from using it? ## 1. Will I get banned from using it?
-You are breaking Discord ToS if you decided to use client mods. But no one ever got banned from using ArmCord or any of the client mods included. If you wish to remove mods, check our documentation. -You are breaking Discord ToS if you decided to use client mods. But no one ever got banned from using ArmCord or any of the client mods included. If you wish to remove mods, check our documentation.
## 2.How does this work? ## 2. How does this work?
-We are using official web app and adding some magic powder to make it all work! -We are using official web app and adding some magic powder to make it all work!
## 3.Can I use this on other architectures or operating systems? ## 3. Can I use this on other architectures or operating systems?
-Yes! ArmCord should work normally under Windows, ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)) and Linux as long as it has NodeJS, npm and Electron support. -Yes! ArmCord should work normally under Windows, ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)) and Linux as long as it has NodeJS, npm and Electron support.