mirror of
https://github.com/smartfrigde/armcord.git
synced 2024-08-14 23:56:58 +00:00
10b7e638de
* Updates and Linting * fix lint task * [ImgBot] Optimize images *Total -- 404.98kb -> 304.38kb (24.84%) /assets/screenshot-1920x1080.png -- 205.00kb -> 123.21kb (39.9%) /build/appx/Square150x150Logo.png -- 9.63kb -> 7.71kb (20%) /assets/ac_icon.png -- 40.15kb -> 34.98kb (12.88%) /assets/StoreLogo.png -- 40.15kb -> 34.98kb (12.88%) /assets/Square150x150Logo.png -- 7.24kb -> 6.53kb (9.83%) /assets/ac_icon_transparent.png -- 45.54kb -> 42.00kb (7.76%) /assets/ac_plug_colored.png -- 17.98kb -> 16.72kb (7%) /assets/ac_black_plug.png -- 8.49kb -> 8.06kb (5.06%) /assets/ac_black_plug_hollow.png -- 10.30kb -> 9.95kb (3.4%) /build/appx/Square44x44Logo.png -- 1.69kb -> 1.64kb (2.89%) /assets/Square44x44Logo.png -- 1.90kb -> 1.85kb (2.83%) /assets/Wide310x150Logo.png -- 4.21kb -> 4.17kb (0.97%) /build/appx/Wide310x150Logo.png -- 4.21kb -> 4.17kb (0.97%) /assets/ac_white_plug.png -- 8.49kb -> 8.42kb (0.83%) Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com> * Asyncification!!! Check `REVIEW` comments * More async for `src/discord` * update packages to latest minor version * Void some promises * Add some types - 93 problems left! * make DeepScan Happy * DeepScan part 2 * I am the Constant * preload must be `.mts` * Migrate electron context menu official package * fix bad preload on setup window * fix minor import oversights * fix modloader * Stop main window from continuing during setup * update packages, slow dependabot * Remove paste override, it seems to work without now * IPC typing * Package updates & a few more typings * fix linting errors in screenshare * use pnpm in actions * fix dev releaser? * update node build, fix dev one more time * release action is broke * Fix Release * update actions * actions are so finicky * remove delete-tag-and-release * add github token env * Hopefully this fixes the release workflow * [debug] * this should actually fix it * Fix typo in dev action * put everything in a dir and then get it * use a different releaser * correct release file location * action places it in a folder named x.zip, recurse into that and grab the actual files * Cleanup actions a bit * release is dependent on mac build * remove mac build * split linux arm and x86 * rely on linux arm * remove deprecated action * attempt to fix weird recursive zip * fix env * use pnpm in actions fix dev releaser? update node build, fix dev one more time release action is broke Fix Release update actions actions are so finicky remove delete-tag-and-release add github token env Hopefully this fixes the release workflow [debug] this should actually fix it Fix typo in dev action put everything in a dir and then get it use a different releaser correct release file location action places it in a folder named x.zip, recurse into that and grab the actual files Cleanup actions a bit release is dependent on mac build remove mac build split linux arm and x86 rely on linux arm remove deprecated action attempt to fix weird recursive zip fix env * don't globally install pnpm packages (I don't think the cache checks global) * Type the armcord window * Finalize typings * fix deepscan issues * fix screenshare preload * fix app quitting --------- Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com> Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com> Co-authored-by: smartfrigde <37928912+smartfrigde@users.noreply.github.com>
206 lines
8.2 KiB
Markdown
206 lines
8.2 KiB
Markdown
|
|
<div align="center">
|
|
<img src="https://armcord.app/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 any way.
|
|
|
|
- **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!
|
|
|
|
- **Themes**
|
|
|
|
ArmCord natively supports theming of the entire app, you can easily import BetterDiscord themes and manage them
|
|
|
|
- **Made for Privacy™**
|
|
|
|
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 **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**
|
|
|
|
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?
|
|
|
|
## Packaging status
|
|
|
|
[](https://repology.org/project/armcord/versions)
|
|
|
|
### Windows
|
|
|
|
<a href="https://microsoft.com/store/apps/9PFHLJFD7KJT">
|
|
<img src="https://get.microsoft.com/images/en-us%20dark.svg" alt="Download ArmCord" />
|
|
</a>
|
|
|
|
If you're using an older version of Windows, you need to use [pre-built installers](https://www.armcord.app/download).
|
|
|
|
### 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>
|
|
|
|
### 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:
|
|
|
|
```sh
|
|
curl -fsSL https://apt.armcord.app/public.gpg | sudo gpg --dearmor -o /usr/share/keyrings/armcord.gpg
|
|
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/armcord.gpg] https://apt.armcord.app/ stable main" | sudo tee /etc/apt/sources.list.d/armcord.list
|
|
sudo apt update
|
|
sudo apt install armcord
|
|
```
|
|
|
|
If you previously used old ArmCord apt repo, here's how you can remove it:
|
|
|
|
```sh
|
|
sudo rm /etc/apt/sources.list.d/armcord.list
|
|
sudo rm /usr/share/keyrings/armcord.gpg
|
|
sudo apt update
|
|
```
|
|
|
|
### 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>
|
|
|
|
Similar to `armcord-git` on AUR, you can install the latest dev builds through snaps by running this command:
|
|
|
|
```shell
|
|
sudo snap install armcord --channel=latest/edge
|
|
```
|
|
|
|
Snapd will automatically update the app including developer builds.
|
|
|
|
### Winget Package
|
|
|
|
ArmCord is also available on the [winget-pkgs](https://github.com/microsoft/winget-pkgs) repository:
|
|
|
|
```ps1
|
|
winget install ArmCord.ArmCord
|
|
```
|
|
|
|
### Scoop package
|
|
|
|
ArmCord is also available on [Scoop extras](https://github.com/ScoopInstaller/Extras) repo:
|
|
|
|
```ps1
|
|
scoop bucket add extras
|
|
```
|
|
|
|
```ps1
|
|
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, stable release only
|
|
|
|
- [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`
|
|
|
|
### Homebrew repository
|
|
|
|
ArmCord also has a homebrew repository
|
|
|
|
```zsh
|
|
brew tap armcord/armcord
|
|
```
|
|
|
|
```zsh
|
|
brew install --cask armcord
|
|
```
|
|
|
|
### FreeBSD
|
|
|
|
You can also get ArmCord running on FreeBSD by following [these instructions](https://gist.github.com/axyiee/4d29c982ac85d5d26f98a51040b5de37).
|
|
|
|
### Pi-Apps
|
|
|
|
ArmCord is also available in [Pi-Apps](https://github.com/Botspot/pi-apps).
|
|
[](https://github.com/Botspot/pi-apps)
|
|
|
|
### Pre-built binaries:
|
|
|
|
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>
|
|
|
|
### 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):
|
|
|
|
1. Clone ArmCord repo: `git clone https://github.com/ArmCord/ArmCord.git`
|
|
2. Run `pnpm install` to install dependencies
|
|
3. Build with `pnpm run build`
|
|
4. Compile/Package with `pnpm run package`
|
|
|
|
# FAQ
|
|
|
|
## Do you have a support Discord?
|
|
|
|
[](https://discord.gg/TnhxcqynZ2)
|
|
|
|
## 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 can I access the settings?
|
|
|
|
- Open Discord settings and there should be a button `ArmCord Settings` button with a white Discord icon, you can also right click on the tray icon and click `Open Settings`
|
|
|
|
## 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 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?
|
|
|
|
- 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?
|
|
|
|
- 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/).
|
|
|
|
# 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)
|
|
|
|
Discord is trademark of Discord Inc. ArmCord is not affiliated with or endorsed by Discord Inc.
|