armcord/README.md

35 lines
1.8 KiB
Markdown
Raw Normal View History

2021-05-04 10:24:24 +00:00
2021-05-12 14:54:32 +00:00
# ![Arm with a Cord](https://raw.githubusercontent.com/kckarnige/armcord/main/arm-with-a-cord.svg)
ArmCord is a custom alternative Discord client made for people on lower-end devices and ARM architecture that want custom Discord experience. It uses [GooseMod](https://goosemod.com) for custom themes and plugins!
2021-05-01 17:53:38 +00:00
2021-03-20 19:07:15 +00:00
# How to run/install it?
2021-07-18 13:10:33 +00:00
Check releases tab for precompiled packages for Linux, Windows and Mac OS (experimental).
Alternatively you can run ArmCord from source (npm, nodejs required):
2021-05-01 12:48:50 +00:00
1.Run `npm install`
2021-05-01 13:14:25 +00:00
2.Run `npm start`
2021-05-10 10:03:42 +00:00
3.Compile/Package with `npm run make`
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
2021-05-01 13:46:53 +00:00
## 1.Will I get banned from using it?
2021-07-22 12:50:30 +00:00
-You are breaking Discord ToS since we are using GooseMod for themes and plugins. But no one ever got banned from using ArmCord or GooseMod as of now. If you wish to remove GooseMod, you can find it in your plugins folder.
2021-05-01 13:46:53 +00:00
## 2.How does this work?
-We are using official web app and adding GooseMod to it with some other tweaks.
2021-05-01 17:08:41 +00:00
## 3.Can I use this on other architectures or operating systems?
2021-11-01 10:47:32 +00:00
-Yes! ArmCord should work normally under Windows, ~~Mac OS~~ (Mac OS is broken see [#48](https://github.com/ArmCord/ArmCord/issues/48)), Linux as long as it has NodeJS, npm and Electron support.
## 4.Code is big spaghetti.
2020-11-16 13:59:19 +00:00
2021-11-01 10:47:32 +00:00
-I'm aware. I'm slowly rewriting everything. This branch is mostly fixes only.
2021-05-02 16:23:46 +00:00
2021-05-04 10:18:49 +00:00
# Credits
2021-05-10 09:53:52 +00:00
[ArmCord UI Elements and few features](https://github.com/kckarnige)
2021-05-04 10:20:10 +00:00
[GooseMod](https://github.com/GooseMod/GooseMod)
2021-06-26 19:02:50 +00:00
[GooseMod Extension](https://github.com/GooseMod/extension)
2021-05-04 10:20:10 +00:00
[electron-discord-webapp](https://github.com/SpacingBat3/electron-discord-webapp)
[custom-electron-titlebar](https://github.com/AlexTorresSk/custom-electron-titlebar)
[electron-localshortcut](https://github.com/parro-it/electron-localshortcut)
2021-07-18 13:10:33 +00:00
[electron-builder](https://electron.build)