comcord/README.md

# 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)
  - [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] Message Receiving
  - [ ] 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
  - [ ] 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
- [ ] Configuration
  - [ ] Default guild/channel
- [ ] Threads
- [ ] Not have the token just be in argv
- [ ] Not have everything in one file
initial commit 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`
command system, message sending and receiving (untested) 2022-08-28 00:14:10 +00:00			`- [x] Commands`
			`- [x] Quit (q)`
guild switching and user listing 2022-08-28 01:53:55 +00:00			`- [x] Switch guilds (G)`
support for replies 2022-08-28 02:57:40 +00:00			`- [x] Switch channels (g)`
guild switching and user listing 2022-08-28 01:53:55 +00:00			`- [x] List online users in guild (w)`
support for replies 2022-08-28 02:57:40 +00:00			`- [x] Emote (e)`
initial commit 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`
implement history 2022-08-28 03:22:06 +00:00			`- [x] Room history (r)`
			`- [x] Extended room history (R)`
command system, message sending and receiving (untested) 2022-08-28 00:14:10 +00:00			`- [x] Message Receiving`
initial commit 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`
command system, message sending and receiving (untested) 2022-08-28 00:14:10 +00:00			- [x] Messages wrapped in `*`'s or `_`'s parsed as emotes
initial commit 2022-08-27 23:27:05 +00:00			`- [ ] Inline DMs to replicate commode's private messages`
implement history 2022-08-28 03:22:06 +00:00			`- [x] Replies`
command system, message sending and receiving (untested) 2022-08-28 00:14:10 +00:00			`- [x] Message sending`
			`- [x] Puts incoming messages into queue whilst in send mode`
initial commit 2022-08-27 23:27:05 +00:00			`- [ ] Mentions`
			`- [ ] Replies`
			`- [ ] Configuration`
			`- [ ] Default guild/channel`
			`- [ ] Threads`
command system, message sending and receiving (untested) 2022-08-28 00:14:10 +00:00			`- [ ] Not have the token just be in argv`
guild switching and user listing 2022-08-28 01:53:55 +00:00			`- [ ] Not have everything in one file`