alterae/discord-bot

A general-purpose discord bot written in TypeScript

hello, world!

i'm alterae, and this is my github. i like making things and sometimes i actually do so

pronouns: she/her or they/them

links:

• sourcehut
• itch.io
• mastodon

discord-bot's Issues

Contributing Guidelines

We need some contributing guidelines, architecture documentation.

Embeds and Improved Output

Is your feature request related to a problem? Please describe.
The current plaintext output is boring, limited, and difficult to distinguish from non-bot messages.

Describe the solution you'd like
The bot should, by default, send messages using embeds, unless it lacks permission or is explicitly told not to, in which case it should fall back to plaintext.

Describe alternatives you've considered
Sticking with the current system is doable but I don't want to.

Additional context
Probably requires overhauling the command parser to add flags.

Type files

I'm not sure, but it might be a good idea for the type definition files to be renamed from .ts to .d.ts. Look into it more.

Bot does not change status to offline when it stops

Describe the bug
When the bot stops, it still displays as online in Discord for a short time.

To Reproduce

1. Start the bot.
2. Stop the bot (either through ^C in console or the !stop command.

Expected behavior
The bot should display as offline immediately when stopped.

Screenshots

Additional context
It does go offline after a delay.

Ability to flip multiple coins at once

Is your feature request related to a problem? Please describe.
Calling !flip repeatedly is annoying.

Describe the solution you'd like
!flip [num], where num is a positive integer, should flip that many coins and output the results of each flip.

Describe alternatives you've considered
We could stick with the current simple system but I would rather not.

Slash Commands Refactor

probably start from scratch for this tbh

Set up Typescript base URL

This will save massive hassle by preventing ../.. imports.

https://www.typescriptlang.org/tsconfig#baseUrl

Refactor `help` command

Help command is currently weirdly implemented. That needs fixing.

We can grab the commands list by just importing it because it's its own module.

Comments

The code needs commenting or I'm going to lose the ability to make sense of it.

Issue Template

We should have one.

Properly set up Prettier

Need to add it as a local dependency, add a (probably empty) config file, and set it to ignore the out/ folder.

Show informative status message

Is your feature request related to a problem? Please describe.
The status message is unset and there is nothing indicating to users what the prompt is.

Describe the solution you'd like
Once the client is ready, set the status message to something explaining the help command.

Describe alternatives you've considered
Setting the bot's nickname would be dumb.

Additional context
This is a pretty common thing. The only real question is how exactly we wanna go about it.

Add detailed help for specific commands

Is your feature request related to a problem? Please describe.
Currently, the only usage of the help command is !help, which lists all available commands. This is annoying, as it sends a long message and offers no specificity.

Describe the solution you'd like
!help [command] should display help on the given command. If the command does not exist (or is hidden), it should send an error message.

Describe alternatives you've considered
We could just not do this but usability will suffer in the long term once more commands are added.

Additional context
This can probably be done with the current (space separated) argument system.
Maybe also implement a --help flag once flags are actually implemented?

Move author ID to `.env` file

It is probably sufficiently sensitive and spooky that we want to put it in there. Also hardcoding is bad and at present it is hardcoded.

Dice rolling command

Is your feature request related to a problem? Please describe.
Dice rolling is useful and we do not currently have it.

Describe the solution you'd like
Add a command that accepts dice notation and returns a result.

Describe alternatives you've considered
We could just do !roll [dice] [sides] but that would be lame. Dice notation is (though harder to parse) far better.

Additional context
I'll have to look over my notes on dice rolling. Maybe get that NPM library made lol :p
In actuality it's probably important to keep this as simple as possible to minimize the difficulty in writing it.