The epl monorepo, a Litecord compatible/inspired OSS implementation of Discord's backend for fun and profit.
Find a file
2022-05-03 02:31:41 -04:00
.github chore: Initial commit 2022-05-03 02:31:41 -04:00
.gitlab chore: Initial commit 2022-05-03 02:31:41 -04:00
src chore: Initial commit 2022-05-03 02:31:41 -04:00
.gitignore chore: Initial commit 2022-05-03 02:31:41 -04:00
Cargo.lock chore: Initial commit 2022-05-03 02:31:41 -04:00
Cargo.toml chore: Initial commit 2022-05-03 02:31:41 -04:00
CODE_OF_CONDUCT.md chore: Initial commit 2022-05-03 02:31:41 -04:00
CONTRIBUTING.md chore: Initial commit 2022-05-03 02:31:41 -04:00
LICENSE chore: Initial commit 2022-05-03 02:31:41 -04:00
README.md chore: Initial commit 2022-05-03 02:31:41 -04:00

epl

A Litecord compatible/inspired OSS implementation of Discord's backend for fun and profit.

Why?

Like I said, fun and profit!

In all seriousness, this project is intended as a way to understand the Discord API in a more familiar stack to help speed up implementing new features and fixing bugs for Litecord.

As such, the Epl project has the same goals as the original Litecord project.

Being Litecord compatible also means we will be using Litecord's LVSP protocol, mediaproxy, and admin API.

Status

Big ol tables of features and their implementation status.

v6

(To be filled out)

Feature Status Notes

v9

(To be filled out)

Feature Status Notes

Installation/Running

Requirements

Runtime

Required:

  • Some sort of compatible libc

Optional:

Development

Required:

Optional:

Configuration

Variable Description Example Required? Default
RUST_LOG Rust logging level (See env_logger) INFO ERROR
NAME The instance's name Epl [x] N/A
URL The instance's main URL epl.dev [x] N/A
GATEWAY_URL The URL of the Gateway (Must be accessible to clients) gateway.epl.dev [x] N/A
MEDIAPROXY_URL The URL of the Litecord mediaproxy media.epl.dev N/A
HTTP_LISTEN_ADDR Listen address of the HTTP API 0.0.0.0:3926 0.0.0.0:3926
GATEWAY_LISTEN_ADDR Listen address of the gateway socket 0.0.0.0:5001 0.0.0.0:5001
POSTGRES_ADDR PostgreSQL database URL postgres://username:password@localhost/database [x] N/A
REDIS_ADDR Redis database URL redis://127.0.0.1:6379 redis://127.0.0.1:6379
LVSP_SECRET LVSP Shared Secret, can be anything (Must be the same on the LVSP server) supersecret [x] N/A
REQUIRE_SSL Whether or not SSL protocols will be used (wss:// https://) true false

Contributing

Please read the contributing guide and the code of conduct.

Especially the commit message style guidelines.