diff --git a/.github/assets/screenshot_chat.png b/.github/assets/chat.png similarity index 100% rename from .github/assets/screenshot_chat.png rename to .github/assets/chat.png diff --git a/.github/assets/screenshot_drawer.png b/.github/assets/drawer.png similarity index 100% rename from .github/assets/screenshot_drawer.png rename to .github/assets/drawer.png diff --git a/.github/assets/themed_chat.png b/.github/assets/themed_chat.png new file mode 100644 index 00000000..20275b48 Binary files /dev/null and b/.github/assets/themed_chat.png differ diff --git a/.github/assets/themed_drawer.png b/.github/assets/themed_drawer.png new file mode 100644 index 00000000..701f5b04 Binary files /dev/null and b/.github/assets/themed_drawer.png differ diff --git a/README.md b/README.md index fa1bbf4f..86209193 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,52 @@ -# OpenCord +

OpenCord

+

+ + Discord + +

+

+ GitHub Repo stars + GitHub forks + + License + + + Crowdin + +
+

+ An open-source Material You implementation of the Discord Android app. (WIP) +

+

+ +## Preview + +| Chat | Drawer | +|:-------------------------------------------------------:|:---------------------------------------------------------:| +| | | +| | | -[![Discord](https://img.shields.io/discord/885879572447522817.svg?color=blue&label=OpenCord&logo=discord&style=for-the-badge)](https://discord.gg/3y6vbneMsW) -[![Crowdin](https://badges.crowdin.net/opencord/localized.svg)](https://crowdin.com/project/opencord) - -An open-source Material You implementation of the Discord Android app. (WIP) +## FAQ -| Chat | Drawer | -|:---------------------------------------:|:-----------------------------------------:| -| ![](.github/assets/screenshot_chat.png) | ![](.github/assets/screenshot_drawer.png) | +### Will this client support "plugins" or custom features/themes? -## Why does this exist? +Most likely in the future, however our first priority is to implement most of the stock client's +features. To check our current progress, see [STATUS.md](/STATUS.md). You are always welcome to fork +and add features or do it just privately! -Current Discord app sucks as it doesn't support any type of customization (themes, plugins, layout -etc...). The goal of this project is to reimagine the Discord experience on mobile devices. +### Is this against Discord TOS? -## Status of OpenCord +Yes, it is. However, there has been no instances of Discord banning people for just using modified +clients. What they do automatically ban for, is API abuse or strange requests. Therefore, OpenCord +takes great caution in emulating official clients exactly, but as it is still in development, please +***use an alt account for your safety.*** -- [ ] Full (or at least most essential) Discord feature implementation -- [ ] Theme support -- [ ] Plugin support -- [ ] Multiplatform support (Windows, macOS, Linux, Android) +### Where download???!?!?!?!? -for more information see [STATUS.md](/STATUS.md) +Since there is no release version yet, use +this [nightly link](https://nightly.link/materiiapps/opencord/workflows/android/master/opencord.zip) +to download OpenCord. Download, extract and install the APK contained within. If you are +reinstalling or updating, you have to uninstall the old version first! ## Building locally @@ -38,22 +63,3 @@ Linux/macOS: ``` Built APK will be at `app/build/outputs/apk/debug/app-debug.apk` - -## FAQ - -### Will this client support themes/plugins? - -Yes, but the first priority is to implement most of the stock client's features - -### Is this against Discord TOS? - -Yes, it is. However, there has been no instances of Discord banning people for just using modified -clients. What they do automatically ban for, is API abuse or strange requests. Therefore, OpenCord -takes great caution in emulating official clients exactly, but as it is still in development, please -use an alt account for your safety. - -### Where download???!?!?!?!? - -Since there is no release version yet, use -this [nightly link](https://nightly.link/materiiapps/opencord/workflows/android/master/opencord.zip) -to download OpenCord. Download, extract and install the APK contained within. diff --git a/STATUS.md b/STATUS.md index 77af555b..0d8c1d18 100644 --- a/STATUS.md +++ b/STATUS.md @@ -13,17 +13,19 @@ - [ ] Spoiler - [ ] Timestamps - [ ] Stickers + - [ ] Code blocks + - [ ] Inline code blocks - [x] Replies - [x] Timestamp - [x] Edited - [x] Pinned - [ ] Reactions - - [ ] Sender - - [ ] Avatar - - [ ] Guild + - [x] Sender + - [x] Avatar + - [x] Guild - [x] User - - [ ] Name - - [ ] Guild + - [x] Name + - [x] Guild - [x] User - [ ] Slash commands - [ ] Sending @@ -64,6 +66,7 @@ - [ ] Rules - [ ] Category - [x] Collapse/Expand + - [ ] Syncing data - [ ] Unread indicator - [ ] Threads - [ ] Permissions @@ -114,13 +117,3 @@ - [ ] Status - [ ] Text - [x] Indicator - -## App - -- [ ] Multiplatform - - [x] Android - - [ ] Windows - - [ ] Linux - - [ ] macOS -- [ ] Plugins -- [ ] Themes