73 lines
2.9 KiB
Markdown
73 lines
2.9 KiB
Markdown
# 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>`
|
|
Your token will be then stored in `.comcordrc` after the first launch.
|
|
|
|
### User Accounts
|
|
User accounts are *partially* supported via `allowUserAccounts=true` in your `.comcordrc`.
|
|
This is use at your own risk, despite spoofing the official client. I am not responsible for any banned accounts.
|
|
|
|
#### Guild members not populating
|
|
This is due to Oceanic not implementing Lazy Guilds as they are user account specific. **DO NOT bother Oceanic to implement it!** They are purely a bot-focused library.
|
|
|
|
If you are willing to implement Lazy Guilds based off of [unofficial documentation](https://luna.gitlab.io/discord-unofficial-docs/lazy_guilds.html)
|
|
and my already existing horrible hacks to make user accounts work in the first place, feel free to send a PR (on GitLab, GitHub repo is a read only mirror).
|
|
|
|
### Bot Accounts (prefered)
|
|
You **MUST** grant your bot all Privileged Gateway Intents.
|
|
|
|
## Design Decisions
|
|
* Node.js was chosen currently due to familiarity.
|
|
* Oceanic 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)
|
|
- [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] List channels (l)
|
|
- [x] List guilds (L)
|
|
- [x] Clear (c)
|
|
- [ ] Surf channels forwards (>)
|
|
- [ ] Surf channels backwards (<)
|
|
- [x] AFK toggle (A)
|
|
- [x] Send DM (s)
|
|
- [x] Answer DM (a)
|
|
- [x] Message Receiving
|
|
- [x] Markdown styling
|
|
- [ ] Common markdown (bold, italic, etc)
|
|
- [ ] Figure out how spoilers would work
|
|
- [x] Emotes?????
|
|
- [x] Timestamp parsing
|
|
- [x] Mentions parsing
|
|
- [ ] Embeds in the style of commode's posted links
|
|
- [x] Messages wrapped in `*`'s or `_`'s parsed as emotes
|
|
- [ ] Inline DMs to replicate commode's private messages
|
|
- [x] Replies
|
|
- [x] Message sending
|
|
- [x] Puts incoming messages into queue whilst in send mode
|
|
- [ ] Mentions
|
|
- [ ] Replies
|
|
- [x] Configuration
|
|
- [x] Default guild/channel
|
|
- No way to set in client (yet?), `defaultChannel=` and `defaultGuild=` in your `.comcordrc`.
|
|
- [ ] Threads
|
|
- [x] Not have the token just be in argv
|
|
- [x] Not have everything in one file
|