comcord/README.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2022-08-27 23:27:05 +00:00
# comcord
A CLI-based client for Discord inspired by [SDF](https://sdf.org)'s [commode](https://sdf.org/?tutorials/comnotirc).
## Why?
1. All CLI/TUI Discord clients are outdated/unmaintained or have flaws.
2. I've been spending more time in commode on SDF and have been accustomed to the experience.
## Usage
1. `pnpm i`
2. `node src/index.js <token>`
Currently only bot accounts are supported, and that is unlikely to change anytime soon.
Eris has a lot of user-only endpoints implemented, but it would require hacking apart Eris to do the things nessicary to spoof being the actual client.
I also don't want to give skids an easy point of reference of how to spoof the client. :^)
You **MUST** grant your bot all Privileged Gateway Intents.
## Design Decisions
* Node.js was chosen currently due to familiarity.
* Eris was chosen due to familiarity and the nature of everything not being abstracted out to 200 different classes unlike discord.js.
* "Jank" by design. While I don't expect anyone to actually use comcord on serial terminals or teletypes other than for meme factor, the option is still there.
## TODO
- [x] Commands
- [x] Quit (q)
2022-08-28 01:53:55 +00:00
- [x] Switch guilds (G)
2022-08-28 02:57:40 +00:00
- [x] Switch channels (g)
2022-08-28 01:53:55 +00:00
- [x] List online users in guild (w)
2022-08-28 02:57:40 +00:00
- [x] Emote (e)
2022-08-27 23:27:05 +00:00
- Just sends message surrounded in `*`'s
- [ ] Finger (f)
- [ ] Shows presence data if available
- [ ] Creation date, join date, ID, etc
2022-08-28 03:22:06 +00:00
- [x] Room history (r)
- [x] Extended room history (R)
2022-08-28 03:56:02 +00:00
- [x] List channels (l)
2022-08-28 03:40:53 +00:00
- [x] List guilds (L)
- [x] Clear (c)
- [ ] Surf channels forwards (>)
- [ ] Surf channels backwards (<)
- [x] Message Receiving
2022-08-27 23:27:05 +00:00
- [ ] Markdown styling
- [ ] Common markdown (bold, italic, etc)
- [ ] Figure out how spoilers would work
- [ ] Emotes?????
- [ ] Timestamp parsing
- [ ] Embeds in the style of commode's posted links
- [x] Messages wrapped in `*`'s or `_`'s parsed as emotes
2022-08-27 23:27:05 +00:00
- [ ] Inline DMs to replicate commode's private messages
2022-08-28 03:22:06 +00:00
- [x] Replies
- [x] Message sending
- [x] Puts incoming messages into queue whilst in send mode
2022-08-27 23:27:05 +00:00
- [ ] Mentions
- [ ] Replies
- [ ] Configuration
- [ ] Default guild/channel
- [ ] Threads
- [ ] Not have the token just be in argv
- [x] Not have everything in one file