ModEngine Documentation

Welcome to the official documentation for ModEngine. This guide provides all the information you need to invite, use, and self-host the bot.

Getting Started

The easiest way to use ModEngine is by inviting the publicly hosted version to your Discord server. This requires no setup on your part.

Click the link below and select the server you wish to add the bot to. You will need "Manage Server" permissions.

Invite ModEngine to Your Server →

Self-Hosting Guide

For advanced users who want full control and customization, self-hosting is the best option. Follow these steps to get your own instance running.

  1. Download Files: Get the latest source code by downloading the ZIP file.
  2. Install Dependencies: After extracting the files, open a terminal in the project's root directory and run the command: 
    pip install -r requirements.txt
  3. Configure Token: Create a file named .env in the root directory and add your bot token like this: DISCORD_TOKEN=YourTokenHere. Alternatively, you can place it in config.json.
  4. Run the Bot: Start the bot using Python: 
    python utility_bot.py

Moderation Commands

These are the core commands for managing users and maintaining order in your server.

Ban / Unban

Permanently removes a user from the server. You can unban them to allow them to rejoin.

/ban <user> [reason]
/unban <user_id>

Kick

Removes a user from the server. They can rejoin immediately if they have a valid invite.

/kick <user> [reason]

Mute / Unmute

Prevents a user from sending messages in text channels or speaking in voice channels.

/mute <user> [duration] [reason]
/unmute <user>

Warn / Unwarn

Issues a formal warning to a user, which is logged by the bot. You can also remove the latest warning.

/warn <user> <reason>
/unwarn <user>

Warnings Overview

Displays a list of all warnings a specific user has received.

/warnings <user>

Utility Commands

Tools to configure the bot, manage channels, and get helpful information.

Lock / Unlock Channel

Prevents or allows the `@everyone` role from sending messages in a specific channel.

/lock [channel]
/unlock [channel]

Purge

Bulk deletes a specified number of messages from a channel. (Max 100 at a time)

/purge <amount>

Set Prefix

Changes the command prefix for the bot on this server.

/setprefix <new_prefix>

Help

Displays a list of all available commands and their descriptions.

/help

Ping

Checks the bot's response time and API latency.

/ping

Logging System

If you choose not to use the optional logging features, you may see the following message upon startup. This is purely informational and can be safely ignored.

Error loading LoggingCog: Extension 'logging_cog' not found. This does not affect the bot's core functionality.

Support

If you encounter any issues, have questions, or want to contribute to the project, please join our official Support Server. The community and developers are there to help.

ModEngine is an open-source project created by CubeZockii. Contributions are always welcome!