Skip to content

Commit

Permalink
feat: improve readme (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
rushiiMachine authored Dec 10, 2022
1 parent 4d096e4 commit 20267cb
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 51 deletions.
File renamed without changes
File renamed without changes
Binary file added .github/assets/themed_chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/themed_drawer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
78 changes: 42 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,52 @@
# OpenCord
<h1 align="center">OpenCord</h1>
<p align="center">
<a href="https://discord.gg/3y6vbneMsW">
<img alt="Discord" src="https://img.shields.io/discord/885879572447522817.svg?label=OpenCord&logo=discord&style=for-the-badge&logoColor=FFFFFF">
</a>
</p>
<p align="center">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/MateriiApps/OpenCord?logo=github&style=for-the-badge">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/MateriiApps/OpenCord?logo=github&style=for-the-badge">
<a href="https://github.com/MateriiApps/OpenCord/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/MateriiApps/OpenCord?color=%23007ec6&style=for-the-badge">
</a>
<a href="https://crowdin.com/project/opencord">
<img alt="Crowdin" src="https://badges.crowdin.net/opencord/localized.svg">
</a>
<br/>
<p align="center">
An open-source Material You implementation of the Discord Android app. (WIP)
</p>
</p>

## Preview

| Chat | Drawer |
|:-------------------------------------------------------:|:---------------------------------------------------------:|
| <img src=".github/assets/chat.png" width="200"/> | <img src=".github/assets/drawer.png" width="200"/> |
| <img src=".github/assets/themed_chat.png" width="200"/> | <img src=".github/assets/themed_drawer.png" width="200"/> |

[![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

Expand All @@ -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.
23 changes: 8 additions & 15 deletions STATUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -64,6 +66,7 @@
- [ ] Rules
- [ ] Category
- [x] Collapse/Expand
- [ ] Syncing data
- [ ] Unread indicator
- [ ] Threads
- [ ] Permissions
Expand Down Expand Up @@ -114,13 +117,3 @@
- [ ] Status
- [ ] Text
- [x] Indicator

## App

- [ ] Multiplatform
- [x] Android
- [ ] Windows
- [ ] Linux
- [ ] macOS
- [ ] Plugins
- [ ] Themes

0 comments on commit 20267cb

Please sign in to comment.