comcord/README.md
2023-07-29 22:37:40 -06:00

62 lines
1.8 KiB
Markdown

# comcord (`rewrite-go`)
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
TODO
## Rewrite Design Decisions
Go is more portable than Node.js
## TODO
- [x] Send mode
- [x] Commands
- [x] Quit (q)
- [x] Switch guilds (G)
- [x] Switch channels (g)
- [x] List online users in guild (w)
- [x] Emote (e)
- Just sends message surrounded in `*`'s
- [ ] Finger (f)
- Shows presence data if available
- Creation date, join date, ID, etc
- [x] Room history (r)
- [x] Extended room history (R)
- [x] Peek (p)
- [x] Cross-guild peek (P)
- [x] List channels (l)
- [x] List guilds (L)
- [x] Clear (c)
- [ ] Surf channels forwards (>)
- [ ] Surf channels backwards (<)
- [ ] AFK toggle (A)
- [ ] Send DM (s)
- [ ] Answer DM (a)
- [x] Current time (+)
- [ ] DM history (TBD)
- [ ] Reply to message (TBD)
- [ ] Toggle color (z)
- [x] Message Receiving
- Markdown styling
- [x] Emotes
- [x] Timestamp parsing
- [x] Mentions parsing
- [ ] Embeds
- [ ] Plain links with title = commode's posted links
- [x] Messages wrapped in `*`'s or `_`'s parsed as emotes
- [x] Inline DMs to replicate commode's private messages
- [x] Replies
- [ ] Group DMs
- [ ] Only works with user accounts, might not even be worth doing
- [x] Message sending
- [x] Puts incoming messages into queue whilst in send mode
- [x] Send typing
- [ ] Mentioning
- [x] Configuration
- [x] Write token from argv into rc file if rc file doesn't exist
- [x] Default guild/channel
- [ ] Threads/Forums
- [ ] External rich presence when using bot accounts