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

update readme [skip ci]

Browse source
This commit is contained in:
smartfridge 2022-12-15 21:02:15 +01:00 committed by GitHub
parent 8e6a3c7518
commit a725512e35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -10,16 +10,21 @@
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 anyway.
- **Various mods built in** - **Various mods built in**
Enjoy Vencord, 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!
- **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**
Unlike other clients ArmCord supports rich presence (game activity) out of the box thanks to [arRPC](https://arrpc.openasar.dev).
- **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.
- **Much more stable** - **Much more stable**
@ -32,8 +37,10 @@
# How to run/install it? # How to run/install it?
### Recommended: ### Recommended:
Check releases tab for precompiled packages for Linux, Windows and Mac OS. Alternatively use our Sourceforge mirror. 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> <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>
## Packaging status
[![Packaging status](https://repology.org/badge/vertical-allrepos/armcord.svg)](https://repology.org/project/armcord/versions)
### Winget Package ### Winget Package
ArmCord is also available on the [winget-pkgs](https://github.com/microsoft/winget-pkgs) repository: ArmCord is also available on the [winget-pkgs](https://github.com/microsoft/winget-pkgs) repository:
``` ```
@ -66,7 +73,7 @@ ArmCord is also available in [Pi-Apps](https://github.com/Botspot/pi-apps).
### Compiling: ### Compiling:
Alternatively you can run ArmCord from source (NodeJS and pnpm 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`
@ -80,14 +87,20 @@ ArmCord is also available in [Pi-Apps](https://github.com/Botspot/pi-apps).
## 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?
- 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.
## How does this work? ## How does this work?
- We are using the official web app and adding some magic powder to make it all 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
## 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).
## 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/).
## Where can I translate this? ## 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). - Translations are done using our [Weblate page](https://hosted.weblate.org/projects/armcord/armcord/).
# Credits # Credits
- [ArmCord UI design, branding, and a few features](https://github.com/kckarnige) - [ArmCord UI design, branding, and a few features](https://github.com/kckarnige)