the-programmers-hangout / chronos Goto Github PK

A lot of commands will be saving config to a flat json file. We need some kind of config system to make that all possible.

things that will be saved in there are: current slowmode per channel, current prefix.
Attention should be taken here to assure that if needed the config can be multi guild. I suggest a json file with this format to start with, extra fields may be needed in the future

  "botOwner": 345541952500006912,
  "guildConfigurations": [
    {
      "guildID": 699595207720566824,
      "logChannel": 735931902359502888,
      "prefix": "+",
      "staffRole": "staff_role_name",
      "slowmodeChannels": [
        "735931902359502888": 1800,
        "757602062241497189": 2400
      ]
    }
  ]
}

• Currently, when we want to get the saved guildConfig for a guild, we use different ways and it's inefficient.
• Your task is to build a clean function that accepts Guild or guild ID as input and return undefined or the guild config object depending on whether it's present or not.
• Put the file in src/utilities/ folder.
• While you're at it, replace all instances of guildConfigurations with your newly created function.

• The slow mode command doesn't work when used without any time units.
• Fix the time argument and prompt accordingly.

Commands like setStaffRole, setLogChannel, setThreshold and setPrefix. Would be stored in a JSON file.

See #7

This should take into account the config for slowmode thresholds in the config and use a timer, or perhaps a clever implementation using some kind of EvictingQueue and looking at the messages creation date

• We've made bot owner configurable. But, we haven't actually implemented it.
• The task is to replace all instances of process.env.OWNERID with the botOwner that is in the config file.
• Make sure that you don't break the code.
• Use botOwner instead of the current BotOwner because we need to stick to camelCase.

• The inhibitor disables access by default. (Because there will be at least one entry in the config file).
• Set the default to guild admin message.member.permissions.has('ADMINISTRATOR') or bot owner this.client.isOwner(message.author) if there are no stored configs for the guild.
• If you return true it'll block the command from being run (inhibit it).
• While you're at it, try to clean up the code, if possible.

something like ++slowmode #hangout 10m

• The prefix of the bot is supposed to be configurable. But, we haven't implemented it yet.
• The task here is to implement the dynamic prefixes depending upon the guild. ( Hint ↗ )
• WARNING! if you implement this, the mentionListener would break. ( Hint - changing this line would fix it ↗ )

• Some of the IDs are parsed and stored as numbers, while the others are stored as strings. The API directly provides strings, so it's better to convert all of them to strings.
• The BotOwner is in the title case. But, we are using camelCase rename all instances of it.
• The indentation of the config.json file is messed up. Needs fixing.

Some kind of enforced style for the entire codebase

the bot prefix is saved in the config but it is hardcoded in the index.js file as "+"

so a lot of bots have this mention -> info embed. Would be very useful for gathering all that information in one place (removes the need for a ping and uptime command)