Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/v3l0c1t13s/reflectcord
REST and Websocket compatibility layer for Discord->Revolt
https://github.com/v3l0c1t13s/reflectcord
backend compatibility-layer discord discord-backend discord-compatibility-layer revolt typescript
Last synced: 6 days ago
JSON representation
REST and Websocket compatibility layer for Discord->Revolt
- Host: GitHub
- URL: https://github.com/v3l0c1t13s/reflectcord
- Owner: V3L0C1T13S
- License: agpl-3.0
- Created: 2022-10-12T21:42:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-30T14:21:56.000Z (11 months ago)
- Last Synced: 2024-04-18T04:59:33.690Z (8 months ago)
- Topics: backend, compatibility-layer, discord, discord-backend, discord-compatibility-layer, revolt, typescript
- Language: TypeScript
- Homepage:
- Size: 4.21 MB
- Stars: 40
- Watchers: 4
- Forks: 2
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Reflectcord
[
](https://rvlt.gg/sasJBbfb)
A REST and Websocket compatibility layer for Discord->Revolt
Reflectcord is a compatibility layer for running Discord apps, games, clients, and bots on top of the open source chat platform [Revolt](https://github.com/revoltchat).
In laymans terms, it translates Discord requests to Revolt requests, and gives Discord apps responses in a form they can understand.
## Features
### Configurable
Need only the Discord API, or maybe just the API and Gateway?
Each component of Reflectcord is designed to run as decoupled as possible from other components, and can run fully independently of each other.
### Secure
Reflectcord uses the Revolt public API, so anything that a normal user can't see, Reflectcord can't see either, reducing your attack surface significantly.
### Portable
Reflectcord doesnt have to be deployed on the same server the target Revolt instance is running on. You can run Reflectcord on any public Revolt instance, even if you don't own it!
## Project status
Many features are fully or partially implemented. The official client works well for most use cases. Many frameworks have also been validated to work with Reflectcord, such as Discord.js.
API V8 and higher are considered stable. Anything lower is experimental.
To check if your framework of choice or client works with Reflectcord, refer to the [Discord apps wiki](https://github.com/V3L0C1T13S/reflectcord/wiki/Discord-Apps-Wiki)
## Screenshots
## Setup
[Server](docs/setup.md)
[Bots](docs/bot_setup.md)
For clients, it's generally recommended you use Diproxi to proxy discord.com requests to your instance.
[Diproxi](docs/diproxi_setup.md)
## Credits
### [Spacebar](https://github.com/spacebarchat)
Server structure, larger utilities, 99% of the work reverse engineering the gateway, more obscure parts of Discords API, the entire WebRTC stack, API middlewares, and more is thanks to the work of Spacebar Chat and its contributors. Seriously, check them out!
### [Litecord](https://gitlab.com/litecord/litecord)
Documented a bunch of undocumented OPCodes, reverse engineered OP8
### [Luna's Unofficial Discord Docs](https://luna.gitlab.io/discord-unofficial-docs)
Mainly responsible for documenting settings protobufs, along with tons of OPCodes.
### [ouwou - Discord Undocumented](https://github.com/ouwou/discord-undocumented)
Documented features such as search and slash commands
## Disclaimer
Discord is trademark of Discord Inc. and solely mentioned for the sake of descriptivity. Mention of it does not imply any affiliation with or endorsement by Discord Inc.