Goals

This issue pertains to the config command, specifically to the event customization features.

When complete, the s!config command should be able to:

• Toggle events on and off
• Set the number of scrambles/solves for a particular event

Specification

File to be edited:src/commands/settings/config.ts

Desired functionality

If competition is currently running

user: s!config event 3x3
scrambler: A competition is currently running, so you can't use this command.
To change your configuration, please end the competition.

Event toggling

user: s!config event 6x6 7x7 5x5 bld
scrambler: You've successfully disabled 6x6, 7x7, and 5x5, and enabled bld!

Solve count customization

user: s!config count fmc 3
scrambler: Successfully updated the scramble count for fmc to 3!

Argument structure

Event toggling

The idea is there should be anywhere from 1 to infinity events that can be toggled in one command. Flip each one from its current state when you mutate the configuration!

• args[0]: Name of the event. Verify this with the Event type.
• args[1]: (optional) Name of the second event. Verify it with the Event type too!
• ...

Solve count customization

• args[0]: Name of the event. Verify with the Event type.
• args[1]: A number between 1-5, inclusive. You'll have to validate the input as a number within this range.

Getting started

The great thing about starting with this command is you'll learn a ton about how the scrambler database is structured. Do your best to get a sense of how the features I've implemented so far work-- the gist is we get the current configuration object from the getConfig(msg) function, update it, and set it with msg.guild.settings.set('comp', { newConfig }) based on the arguments the user provides.

Tips

• There is an Event interface/type that is imported from src/util/comp-util.ts. Use this to validate event names!
• In the file, I've already added the skeleton of the command (including the arguments). All you should have to edit are the event and count functions, which correspond to their respective subcommands.

• Moderators can delete a user's times for
  • An event
  • Every event

• Users can view submissions
  • By themselves (default)
  • From an event
  • From a user

Why not make timer in the bot

Should check to make sure the submission is valid for the event (solve count matches, the event is enabled). Don't worry about an existing submission for that user, just overwrite whatever may have been there before.

• Checks if user is banned
• Correctly parses inputs
• Uploads result to db

Use command mentions in /scrambles
So basically replace

1x1
Generate a 1x1 scramble.

2x2
Generate a 2x2 scramble.

with

</1x1:975496438861693020>
Generate a 1x1 scramble

</2x2:975496438861693021>
Generate a 2x2 scramble.

• Start subcommand
  • Send scrambles according to configuration
• End subcommand
  • Compiles and sends podiums
  • Deletes results from db‼️

Feature Request

The ability to display the image of a scramble, with the scramble.
This javascript library can be used → https://tdecker91.github.io/puzzle-gen/