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>`

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 most libraries not implementing Lazy Guilds, as bots do not need lazy guilds to function.

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.
- Dysnomia 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] Peek (p)
- [x] Message Receiving
  - [x] Markdown styling
    - [x] Common markdown (bold, italic, etc)
    - [x] 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
  - [x] 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

## Repository
If you're viewing this on GitHub or GitLab, you are viewing a read only mirror.
The main repository is located on [Gitdab](https://gitdab.com/Cynosphere/comcord) and is push mirrored to the other two.
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>`
oceanic -> dysnomia 2023-05-31 03:03:44 +00:00
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			Your token will be then stored in `.comcordrc` after the first launch.
initial commit 2022-08-27 23:27:05 +00:00
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			`### User Accounts`
oceanic -> dysnomia 2023-05-31 03:03:44 +00:00			User accounts are _partially_ supported via `allowUserAccounts=true` in your `.comcordrc`.
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			`This is use at your own risk, despite spoofing the official client. I am not responsible for any banned accounts.`
initial commit 2022-08-27 23:27:05 +00:00
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			`#### Guild members not populating`
oceanic -> dysnomia 2023-05-31 03:03:44 +00:00			`This is due to most libraries not implementing Lazy Guilds, as bots do not need lazy guilds to function.`
config support, user account support, private message support 2022-10-10 03:15:53 +00:00
			`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)`
initial commit 2022-08-27 23:27:05 +00:00			`You MUST grant your bot all Privileged Gateway Intents.`

			`## Design Decisions`
oceanic -> dysnomia 2023-05-31 03:03:44 +00:00			`- Node.js was chosen currently due to familiarity.`
			`- Dysnomia 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.`
initial commit 2022-08-27 23:27:05 +00:00
			`## 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)`
add channel listing 2022-08-28 03:56:02 +00:00			`- [x] List channels (l)`
fix help spacing, add clear 2022-08-28 03:40:53 +00:00			`- [x] List guilds (L)`
			`- [x] Clear (c)`
			`- [ ] Surf channels forwards (>)`
			`- [ ] Surf channels backwards (<)`
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			`- [x] AFK toggle (A)`
			`- [x] Send DM (s)`
			`- [x] Answer DM (a)`
markdown 2023-06-21 04:34:42 +00:00			`- [x] Peek (p)`
command system, message sending and receiving (untested) 2022-08-28 00:14:10 +00:00			`- [x] Message Receiving`
move from eris to oceanic 2022-10-09 20:39:15 +00:00			`- [x] Markdown styling`
markdown 2023-06-21 04:34:42 +00:00			`- [x] Common markdown (bold, italic, etc)`
			`- [x] Figure out how spoilers would work`
move from eris to oceanic 2022-10-09 20:39:15 +00:00			`- [x] Emotes?????`
			`- [x] Timestamp parsing`
			`- [x] Mentions parsing`
initial commit 2022-08-27 23:27:05 +00:00			`- [ ] 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
README: update todo 2023-05-31 03:08:07 +00:00			`- [x] 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`
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			`- [x] Configuration`
			`- [x] Default guild/channel`
			- No way to set in client (yet?), `defaultChannel=` and `defaultGuild=` in your `.comcordrc`.
initial commit 2022-08-27 23:27:05 +00:00			`- [ ] Threads`
config support, user account support, private message support 2022-10-10 03:15:53 +00:00			`- [x] Not have the token just be in argv`
refactor everything out of one file, add channel rememberance 2022-08-28 22:01:31 +00:00			`- [x] Not have everything in one file`
oceanic -> dysnomia 2023-05-31 03:03:44 +00:00
			`## Repository`
			`If you're viewing this on GitHub or GitLab, you are viewing a read only mirror.`
			`The main repository is located on [Gitdab](https://gitdab.com/Cynosphere/comcord) and is push mirrored to the other two.`