GithubHelp home page GithubHelp logo

klthemathnerd8 / litecord Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mstrodl/litecord

0.0 0.0 0.0 696 KB

Implementation of Discord's backend

License: MIT License

Shell 0.02% Python 99.98%

litecord's Introduction

Litecord

An open-source, (tries to be) functional implementation of a server that follows the Discord API.

This has real shitty code, good luck

With litecord you can run your own "Discord", locally, by yourself, but with limitations

  • You can't use the official discord client with it, use Atomic Discord instead.
  • Not very good code, expect the unexpected when running your server or accessing one.
  • Voice doesn't work nor is planned to be implemented into Litecord.
  • This is written in Python and it wasn't made to be resilient, don't DDoS a Litecord server
  • Ratelimits doesn't exist, yet.

Installation

Make sure you have MongoDB installed and running.

# Clone the repo
git clone https://github.com/lnmds/litecord.git
cd litecord

# Create a virtual enviroment and install dependencies in it
# Make sure your python is 3.6+
python3 -m venv env/
env/bin/python3 -m pip install -r requirements.txt

# start the server
./run_litecord.sh

Discord libraries

Libraries that are known to work with Litecord

  • discord.js, used by Atomic Discord.
  • discord.py, both the async and rewrite branches.
  • Tip: edit discord.http.Route.BASE in rewrite to your litecord instance.
  • Example discord.http.Route.BASE = 'http://0.0.0.0:8000/api'
  • Discordie
  • Tip: lib/Constants.js, around lines 814 for API base, line 816 for cdn endpoint(/images)
  • Eris
  • Tip: node_modules/eris/lib/rest/RequestHandler.js, line 133

Libraries that are known to not work with Litecord

  • discord.io

Usage

When you start litecord it will fire up 3 servers by the default configuration:

  • Websocket used by the gateway at :12000
  • Websocket used by the voice gateway at :6969
  • A HTTP at :8000

Updating

If you're braindead or smth

# pull
git pull
# profit

Restart the server to apply the changes. There isn't any way of hot reloading.

Folder structure

  • /litecord contains the actual litecord server code.
  • /utils has utilities to use within litecord code.
  • /docs has documentation on how the server actually does its stuff.
  • /boilerplate_data, read this
  • Depending on your installation, you might have a /env directory, DON'T MESS WITH IT., don't install other libraries unless otherwise specified(pls don't break your server instance).

litecord's People

Contributors

lun-4 avatar slice avatar nullpixel avatar mralext20 avatar tilda avatar mstrodl avatar adryd avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.