Yumikord

Elevate your Discord community with Yumiko - a versatile and multifunctional bot!

Explore all the capabilities and commands here.

🛠️ Setup

🔨 Step 1: Creating a Discord Application

Signup for a Discord account here.

Create an application on Discord Developer Portal.

• Under Discord Developer Portal > Applications, click New Applicationand assign a Name.
• Under Discord Developer Portal > Settings > General Information, assign a Description, and App Icon for your application.

🔨 Step 2: Creating a Discord Token

Obtain your Discord token by:

• Navigate to the Discord Developer Portal > Settings > Bot.
• Under Username, there should be a Reset Token button.
• Before resetting, scroll down to Privileged Gateway Intents
• Assign the bot MESSAGE CONTENT INTENT (and SERVER MEMBERS INTENT if you choose to).
• Click Reset Token and complete 2FA if it is enabled on your Discord account.
• Copy your Discord token that will be needed in Step 7.

🔨 Step 3: Assigning Bot Permissions

Invite your bot to desired Discord server using the OAuth2 URL Generator:

• Navigate to Discord Developer Portal > Settings > OAuth2.
• Under OAuth2 URL Generator, assign the bot scope.
• Under Bot Permissions, assign the bot all the text permissions, as well as connect, speak under voice permissions.
• Copy the created URL to invite the bot to your server of choice.

🔨 Step 4: Installing Prerequisites

Please ensure that you have Python and Node.js installed.

Prerequisites:

• Python (3.7 or higher)
• Node.js (includes npm)

🛠️ Installation

⚙️ Step 5: Clone the Repository

• Clone this repository or download the source code.
• Navigate to the project directory in your terminal.

⚙️ Step 6: Setup Environment

Run the appropriate setup script to install the necessary Python & Node.js dependencies and configure your environment.

• For Windows:

  setup.bat
  

• For Unix-like systems (Linux, macOS):

  chmod +x setup.sh
  ./setup.sh
  

⚙️ Step 7: Assigning the Discord Token

• Retrieve your Discord token from the Discord Developer Portal that we set up in Step 2.

• Open the .env file with a text editor (e.g. Notepad) and add your Discord token:

  DISCORD_TOKEN=your_token_here
  

  Keep this token secure and refrain from sharing it, as it will grant anyone with it unrestricted access to your bot and server.

⚙️ Step 8: Running the Application

• Run the bot by using:

  py src/main.py
  

• If successful, "YOURBOTNAME is now running!" will be printed in the terminal. Your bot should appear online in your Discord server.

⚙️ Step 9: Running Commands

To interact with the bot:

• Use commands in any channel where the bot is present.

• Your messages will be displayed in the terminal as:

  [channel] user: "message"
  

  Note: Keep the terminal open to keep the bot running. To stop the bot, simply close the terminal.