mirror of
https://github.com/smartfrigde/armcord.git
synced 2024-08-14 23:56:58 +00:00
parent
6af2fd77a3
commit
a5471bc35a
1 changed files with 16 additions and 16 deletions
32
README.md
32
README.md
|
@ -8,9 +8,9 @@
|
||||||
|
|
||||||
- **Standalone client**
|
- **Standalone client**
|
||||||
|
|
||||||
ArmCord is built as a standalone client and doesn't rely on the original Discord client in anyway.
|
ArmCord is built as a standalone client and doesn't rely on the original Discord client in any way.
|
||||||
|
|
||||||
- **Various mods built in**
|
- **Various mods built-in**
|
||||||
|
|
||||||
Enjoy [Vencord](https://github.com/Vendicated/Vencord), [Shelter](https://github.com/uwu/shelter) and their many features, or have a more vanilla experience, it's your choice!
|
Enjoy [Vencord](https://github.com/Vendicated/Vencord), [Shelter](https://github.com/uwu/shelter) and their many features, or have a more vanilla experience, it's your choice!
|
||||||
|
|
||||||
|
@ -20,15 +20,15 @@
|
||||||
|
|
||||||
- **Made for Privacy™**
|
- **Made for Privacy™**
|
||||||
|
|
||||||
ArmCord automatically blocks all of Discord's trackers; even without any client mods you can feel safe and secure!
|
ArmCord automatically blocks all of Discord's trackers; even without any client mods, you can feel safe and secure!
|
||||||
|
|
||||||
- **Supports Rich Presence**
|
- **Supports Rich Presence**
|
||||||
|
|
||||||
Unlike other clients ArmCord supports rich presence (game activity) out of the box thanks to [arRPC](https://arrpc.openasar.dev).
|
Unlike other clients, ArmCord supports rich presence (game activity) out of the box thanks to [arRPC](https://arrpc.openasar.dev).
|
||||||
|
|
||||||
- **Mobile support**
|
- **Mobile support**
|
||||||
|
|
||||||
ArmCord has a **experimental** mobile support for phones running Linux such as the PinePhone. While this is still far from ideal solution, we're slowly trying to improve it.
|
ArmCord has **experimental** mobile support for phones running Linux such as the PinePhone. While this is still far from an ideal solution, we're slowly trying to improve it.
|
||||||
|
|
||||||
- **Much more stable**
|
- **Much more stable**
|
||||||
|
|
||||||
|
@ -37,7 +37,7 @@
|
||||||
|
|
||||||
- **Cross-platform support!**
|
- **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)!
|
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?
|
# How to run/install it?
|
||||||
|
|
||||||
|
@ -49,12 +49,12 @@
|
||||||
<img src="https://get.microsoft.com/images/en-us%20dark.svg" alt="Download ArmCord" />
|
<img src="https://get.microsoft.com/images/en-us%20dark.svg" alt="Download ArmCord" />
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
If you're using older version of Windows, you need to use [pre-built installers](https://www.armcord.xyz/download).
|
If you're using an older version of Windows, you need to use [pre-built installers](https://www.armcord.xyz/download).
|
||||||
|
|
||||||
### Flatpak
|
### Flatpak
|
||||||
<a href='https://flathub.org/apps/details/xyz.armcord.ArmCord'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.svg'/></a>
|
<a href='https://flathub.org/apps/details/xyz.armcord.ArmCord'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.svg'/></a>
|
||||||
|
|
||||||
### Debian, Ubuntu, Raspbian repository
|
### Debian, Ubuntu and Raspbian repository
|
||||||
ArmCord is available on our official repositories for `apt` package manager. By using this method you'll receive automatic updates and get all the dependencies. Run the following commands to install ArmCord from them:
|
ArmCord is available on our official repositories for `apt` package manager. By using this method you'll receive automatic updates and get all the dependencies. Run the following commands to install ArmCord from them:
|
||||||
```sh
|
```sh
|
||||||
curl -fsSL https://eu.armcord.xyz/pgp-key.public | sudo gpg --dearmor -o /usr/share/keyrings/armcord.gpg
|
curl -fsSL https://eu.armcord.xyz/pgp-key.public | sudo gpg --dearmor -o /usr/share/keyrings/armcord.gpg
|
||||||
|
@ -95,17 +95,17 @@ Install it via an AUR helper tool like `yay`.
|
||||||
|
|
||||||
**Example:** `yay -S armcord-bin`
|
**Example:** `yay -S armcord-bin`
|
||||||
### FreeBSD
|
### FreeBSD
|
||||||
You can also get ArmCord running on FreeBSD by following [this instructions](https://gist.github.com/aaxyria/4d29c982ac85d5d26f98a51040b5de37).
|
You can also get ArmCord running on FreeBSD by following [these instructions](https://gist.github.com/aaxyria/4d29c982ac85d5d26f98a51040b5de37).
|
||||||
### Pi-Apps
|
### Pi-Apps
|
||||||
ArmCord is also available in [Pi-Apps](https://github.com/Botspot/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)
|
[![badge](https://github.com/Botspot/pi-apps/blob/master/icons/badge.png?raw=true)](https://github.com/Botspot/pi-apps)
|
||||||
|
|
||||||
### Pre-built binaries:
|
### Pre-built binaries:
|
||||||
Check **releases tab** for precompiled packages for Linux, Windows and Mac OS. Alternatively use our Sourceforge mirror.
|
Check the **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>
|
<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>
|
||||||
|
|
||||||
### Compiling:
|
### Compiling:
|
||||||
Alternatively you can run ArmCord from source ([NodeJS](https://nodejs.dev), [pnpm](https://pnpm.io/installation#using-npm) and [rust toolchain](https://www.rust-lang.org/tools/install) are required):
|
Alternatively, you can run ArmCord from source ([NodeJS](https://nodejs.dev), [pnpm](https://pnpm.io/installation#using-npm), and [rust toolchain](https://www.rust-lang.org/tools/install) are required):
|
||||||
1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`
|
1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`
|
||||||
2. Run `pnpm install` to install dependencies
|
2. Run `pnpm install` to install dependencies
|
||||||
3. Build with `npm run build`
|
3. Build with `npm run build`
|
||||||
|
@ -120,16 +120,16 @@ ArmCord is also available in [Pi-Apps](https://github.com/Botspot/pi-apps).
|
||||||
- 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.
|
- 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?
|
## 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.
|
- Yes! ArmCord should work normally under Windows, MacOS, and Linux as long as it has Electron support.
|
||||||
|
|
||||||
## How can I access settings?
|
## How can I access the settings?
|
||||||
- Either right click on the tray icon and click `Open Settings` or open Discord settings and scroll the sidebar down until you see information about versions. Click on ArmCord version and the settings window will popout.
|
- Either right-click on the tray icon and click `Open Settings` or open Discord settings and scroll down the sidebar until you see information about versions. Click on the ArmCord version and the settings window will pop out.
|
||||||
|
|
||||||
## How does this work?
|
## How does this work?
|
||||||
- We are using the official web app and wrapping it up in Electron. While you may think this is lame and done like thousands of times before, what makes us unique is that we actually strive for creating a customized experience. You can very easily load in themes and mods with no installers/injectors. You can even make the client have transparency effects and follow fluent design on Windows! At it's core, it's just a simple web wrapper, however we applied many patches to make this work well for you <3
|
- We are using the official web app and wrapping it up in Electron. While you may think this is lame and done like thousands of times before, what makes us unique is that we actually strive for creating a customized experience. You can very easily load themes and mods with no installers/injectors. You can even make the client have transparency effects and follow the fluent design of Windows! At its core, it's just a simple web wrapper, however, we applied many patches to make this work well for you <3
|
||||||
|
|
||||||
## Why is macOS support lacking?
|
## Why is macOS support lacking?
|
||||||
- Due to me not owning any macOS device, I can't easily debug/test or do anything related with it. Of course VMs and Hackintosh machines exist but from my experience these are unreliable or very time consuming to setup and mantain. While ArmCord "works" on macOS you may encounter weird issues or inconsistencies with other apps in terms of how they behave (for example macOS lack of tray).
|
- Due to me not owning any macOS device, I can't easily debug/test or do anything related to it. Of course, VMs and Hackintosh machines exist but from my experience, these are unreliable or very time-consuming to set up and maintain. While ArmCord "works" on macOS you may encounter weird issues or inconsistencies with other apps in terms of how they behave (for example macOS lack of tray).
|
||||||
|
|
||||||
## Where can I find the source code?
|
## Where can I find the source code?
|
||||||
- The source code is on [GitHub](https://github.com/ArmCord/ArmCord/).
|
- The source code is on [GitHub](https://github.com/ArmCord/ArmCord/).
|
||||||
|
|
Loading…
Reference in a new issue