FirstSteps

Below is a guide on how to start using Doraemon. However, this isn't a definitive guide, as every use case is different.

Prerequisites

To begin using Doraemon, you need a few things:

• A Discord Application(found here ), add a bot, and copy your token. Generate a OAuth2 Link. Make sure you enable all the privileged gateway intents.
• PostgreSQL Database .
• The latest .NET Core SDK for your platform.

If all of these have been met, then you can move on to opening the Doraemon.sln file.

Setting the Configuration

Config File

Configuration settings are set within config.json.example, located in Doraemon.Data. Moderation-related configs are set within moderationConfig.json.example within the same directory.

Make sure that config.json's properties are set to "Copy if Newer" inside your properties.

List of Configuration Options

• DbConnection - This is your login to your PostgreSQL database. A connection string usually looks like: Server=127.0.0.1;Port=5432;Database=myDataBase;User Id=myUsername;Password=myPassword;
• Token - This is required to even start your bot. It's how Doraemon connects to the Discord API.
• MainGuildId - The ID of the guild you will be running Doraemon in mainly. This is used for setting up the Mute role in all of your channels.
• Prefix - This is what the default command prefix should be! You can change this to whatever you like.
• PromotionRoleId - The role users can be promoted to using the PromotionModule.
• ModmailCategoryId - The category ID that modmail tickets should be created in.
• ReplyToThreadsWithoutCommand - "true" or "false" without the quotes. If true, you can reply to threads without the use of commands. If false, you will have to use the reply command to reply to modmail threads.

Moderation Config

• BanMessage - What should be sent to a user upon being banned. The {0} arguments are what specify the guild name, and reason. You can add anything after that.
• SpamMessageCountPerUser - How many message a user can send within the SpamMessageTimeout to be counted as someone who is spamming.
• SpamMessageTimeout - How many seconds should the SpamMessageCountPerUser be reset.
• RestrictedWords - An array of words that if a user sends, they will be warned for NSFW language.

Log Configs

• ModLogChannelId - Logs all Moderator actions that are actioned using Doraemon.
• UserJoinedLogChannelId - Logs all user joins.
• MessageLogChanneId - Where messages that are either edited or deleted are sent to.
• PromotionLogChannelId - The channel where user promotions will be logged.
• ModmailLogChannelId - The channel ID that modmail log files will be sent to.
• MiscellaneousLogChannelId - Not used currently. Provide any ID.

If this has been setup, you can start the bot, to learn how, view this wiki page !