cloewen8/cj-fan-server

An open source bot for my fan server! https://discord.gg/8d9xdeJ

Who

I am a full-stack developer with a focus on usable design. Feel free to get in touch.

Where

You can find a preview of my work and contact me at cjloewen.ca, or on LinkedIn at @cjloewen.

cj-fan-server's Issues

Answer command

A command that displays an answer to a query. DuckDuckGo's Instant Answer API will most likely be used (https://duckduckgo.com/api).

Call

A Call class will be initialized and sent to executing commands. This class will:

• Provide methods to access captured args.
• Provide access to core instances.

Mention help

If the bot is mentioned, the help command is to be executed without arguments.

Development configuration

If a user_config.yml file is present, it should be used to override configurations. This file must never be committed (development purposes only).

Snack Time

A game about dolphin users eating fish users.

Original: cloewen8/CJ-Fan-Server-Bot#14.

Secret Roles

Chatting a secret phrase will delete the message and award the user with a special role.

Phrases

• Phrases will be 1 to 3 properly spelled English words,
• they will relate to,
• myself,
• the server, or
• a well known and active member,
• and at any time I may give a hint on how to earn them.

Fridge

A process for requesting and storing fan art related to the server or myself.

A command will be provided to the owner which will accept a user, and optionally a message and/or amount. The command will request the fan art (or multiple if an amount if provided) from the user.

Request

A request will include,

• a heading to identify it as a request,

• a copy of the image,

• instructions to accept the request,

• implications of accepting the request (allowing me to store it in Google Photos),

• and how to send me a message for further questions or comments.

• A request will be made by messaging the user directly.

• If the user enters accept, the request will be accepted.

• Any other messages will be deleted.

• After being accepted,

• The owner will be directly messaged to:

• Provide attribution (will default to Discord user).

• Provide a description (optional).

Acceptable

Upon a request being fully processed,

• the image will be uploaded to Google Photos,
• with full attribution to the Discord user,
• With the provided description (if provided).

Configuration class

Configurations will be provided through a class. Secrets will be loaded in through Environment Variables.

New time command

A command for displaying what is new:

• It's a new second!
• It's a new hour!
• It's a new day!
• It's a new week!
• It's a new year!

A phrase would be selected based on how much time has passed since the command was last called.

Coding standard

Early on, a coding standard should be established to keep the syntax consistent.

• I will start with existing standards for Crystal.
• If justifiable, I may carry over personal standards.

These standards may change at any time. Whoever, all affected code is to be modified to conform.

Ocean command

Displays underwater art, similar to the Bro Time !pony command.

Restrict test access

While running in a development environment, only dolphin users should be able to initiate the bot's features.

Commands Manager

A central class and other types for aiding in the creation of commands.

1. Commands need to be registered.
2. A prefix needs to be identified.
3. A command needs to be identified.
4. Restrictions need to be identified. - The owner can use all commands. Some commands may be associated with a role or only work in a development environment.

Poll command

A command to gather user choices related to a set of 2 or more options. This command will allow options to be specified in 2 ways:

• By ending the topic with : and splitting each option with ,.
  Example: poll What animal would you be?: Cat, Dog, Dolphin, Shark, Panda
• By placing the topic after the command and each option on a new line.
  Example:

  poll What animal would you be?
  Cat
  Dog
  Dolphin
  Shark
  Panda
  

A number reaction will be provided for each option.

Clear command

A command that recreates a channel to effectively clear its history.

Log command

Up to 100 log messages will be saved. These messages may be displayed by the owner using the log command.

Help command

A command that displays help information related to a topic or command.

• Topics may be directly registered with the command.
• Commands will be automatically registered if they were registered with the Commands Manager and fit the requirements.
• All topics and commands will be displayed if the command is called without arguments.
• If a command id or topic name is passed as an argument, more details will be displayed about it.

Topic Requirements

In order for a topic to be registered, it needs to include a short (50 characters) and long (300 characters) description.

Command Requirements

Commands must have a short and long description (same as topic), syntax (how to call the command), and example (how to call the command). The id and restrictions may also be used.

Development server replication

Changes to the production server should automatically be redone on the development server:

• When a channel is created.
• When a channel is deleted.
• When a role is added.
• When a role is deleted.
• When permissions change.
• When non-aethetic changes are made to the server.

Input requests

A method to request input. A message must be provided, additionally,

• A filter function (or pattern).
• A retry number.
• An overloaded variation may be created to request multiple values.

Approval process

A process that requires users to read the server's rules before fully entering.

• Reuse code message.
• Create code message.
• Request approval.
• Process codes.
• Edit invalidated code message.

Stop gracefully

The bot should properly trap the SIGTERM posix signal to gracefully stop (releasing connections and resources).

Theme

A collection of colors to use when creating embeds.

Write templates

Templates for issues and pull requests would be a great way to show what information I'm looking for.

For issues,

• bug reports,
• feature requests,
• and questions.

For pull requests

• I'm not looking for code contribution,
• unless requested,
• including a summary of changes.