Commit 4c4efb61 authored by Luna's avatar Luna 😻

Update README.md

 - add docs/clients.md
parent 15fa2f32
Pipeline #53587144 passed with stages
in 8 minutes and 29 seconds
......@@ -31,10 +31,11 @@ took a shot at writing it again. It works.
## Caveats
- Unit testing is incomplete.
- Currently, there are no plans to support video in voice chats, or the Discord Store.
- You must figure out how to connect to a Litecord instance. Litecord will not
distribute official client code from Discord nor provide ways to modify the
official client.
- Currently, there are no plans to support video in voice chats, or the
Discord Store.
- An unofficial Discord Client is recommended to connect (more on
`docs/clients.md`). Litecord will not distribute official client code from
Discord nor provide ways to modify the official client.
## Implementation status, AKA "Does it work?"
......@@ -54,7 +55,7 @@ time.
We (Litecord and contributors) are not liable for usage of this software,
valid or invalid. If you intend to use this software as a "self-hostable
Discord alternative", you are soely responsible for any legal action delivered
Discord alternative", you are solely responsible for any legal action delivered
by Discord if you are using their assets, intellectual property, etc.
All referenced material for implementation is based off of
......
# Clients that can work with Litecord
- discord-term (https://github.com/cloudrex/discord-term), with manual edits
```diff
diff --git a/src/display.ts b/src/display.ts
index e844553..9e8521a 100644
--- a/src/display.ts
+++ b/src/display.ts
@@ -205,7 +205,15 @@ export default class Display {
...state
};
- this.client = new Client;
+ this.client = new Client({
+ http: {
+ host: 'https://INSTANCE_URL_HERE',
+ cdn: 'https://INSTANCE_URL_HERE',
+ version: 6
+ },
+ fetchAllMembers: true,
+ sync: true
+ });
this.commands = commands;
}
```
## Clients known to not work with litecord
Clients built on libraries that do not have an easy way to edit the base URL are
not suited for Litecord.
- crcophony (https://github.com/freyamade/crcophony), discord.cr
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment