Skip to content

Installation#

A complete guide for both beginners and experienced users to instal and setup MineBot.

1. Install Python#

  1. Download the Installer: Go to the official Python website and download the latest Python installer for Windows.
  2. Run the Installer: Open the downloaded file and run the installer.
  3. Add Python to PATH: Ensure you check the box that says "Add Python to PATH" before clicking "Install Now".
  4. Verify Installation: Open Command Prompt and type python3 --version to verify the installation.
  1. Download the Installer: Visit the official Python website and download the latest Python installer for macOS.
  2. Run the Installer: Open the downloaded .pkg file and follow the installation instructions.
  3. Verify Installation: Open Terminal and type python3 --version to verify the installation.
  1. Update Package List: sudo apt update
  2. Install Python: sudo apt install python3
  3. Verify Installation: python3 --version
  1. Update Package List: sudo dnf update
  2. Install Python: sudo dnf install python3
  3. Verify Installation: python3 --version
  1. Update Package List: sudo pacman -Syu
  2. Install Python: sudo pacman -S python
  3. Verify Installation: python3 --version
  1. Install Python: nix-env -iA nixpkgs.python3
  2. Verify Installation: python3 --version
  1. Update Package List: sudo zypper refresh
  2. Install Python: sudo zypper install python3
  3. Verify Installation: python3 --version
  1. Update Package List: sudo apk update
  2. Install Python: sudo apk add python3
  3. Verify Installation: python3 --version
  1. Update Package List: sudo xbps-install -Syu
  2. Install Python: sudo xbps-install -S python3
  3. Verify Installation: python3 --version
  1. Update Package List: sudo emerge --sync
  2. Install Python: sudo emerge dev-lang/python
  3. Verify Installation: python3 --version

2. Download And Extract Bot#

  1. Download the Files: Download the bot files from BuiltByBit.
  2. Extract the Files: Right-click the downloaded ZIP file and select "Extract All...".
  3. Choose Destination: Select the destination folder and click "Extract".
  1. Download the Files: Download the bot files from BuiltByBit.
  2. Extract the Files: Double-click the downloaded ZIP file to extract it.
  3. Move Files: Move the extracted files to your desired location.
  1. Download the Files: Download the bot files from BuiltByBit.
  2. Extract the Files: Open Terminal and navigate to the directory containing the downloaded ZIP file.
  3. Run Extraction Command: Use the command unzip <filename>.zip to extract the files.
  4. Move Files: Move the extracted files to your desired location.

Create a new bot on Discord's developer portal using the instructions below.

Warning

  • Before proceeding, enable Discord Developer Mode by navigating to Settings -> Advanced -> Developer Mode.
  • Click the images below to zoom them.

Danger

Anyone with access to this token has full access to your bot's account, you should ensure that nobody has access to this token but you. Treat it like a username/password combination, but for bots.

  • 1. Create A New Application

    Create Application
    Head over to Discord's Developer Portal and create a new application.

  • 2. Copy Application Id

    General Information Tab
    In the General Information tab, copy the application ID for the next step.

  • 3. Invite Bot To Your Server

    Create the Invite Link
    Visit this website, ensure "Administrator" and "Use Application Commands" are checked and paste your Client ID from step 2 into "Client ID". Do not change any other options. Then click the "Link".

    Invite the bot to your server and in the final screen, check all boxes to grant all of the permissions we've selected previously.

  • 4. Move Role To Top And Give Administrator Permissions

    Check Permissions
    Drag the "bot" role to the top (it can be below other administrator roles) and ensure it's got the Administrator permission.

  • 5. Navigate To The Bot Tab

    Bot Tab
    Access the bot settings in this tab.

  • 6. Create A New Token

    Reset Token
    Generate a new token for your bot and keep it private.

  • 7. Paste Your Token To configuration/settings.yml

    Write Token
    Write your token to your configuration/settings.yml file .

  • 8. Give Bot Privileged Intents

    Give Intents
    Adjust 3 Privileged Gateway Intents as per the image above.

  • 9. Copy Your Guilt Id

    Copy ID
    Copy the Discord server id (guild id) that you plan to use with MineBot.

  • 10. Paste Your Guild Id To configuration/settings.yml

    Paste ID
    Paste the Discord server guild ID that you copied in the same config file where you set the bot token in step 8.

  • 11. Done!

    You're done! All other settings are optional. However, we highly recommend linking it with your Minecraft server to get the most functionality out of it in the "server" section of the same file from step 8 and 10.

4. Start The Bot#

Warning

You need to re-run steps 1, 3 and 4 from below each time you reboot your machine or close the terminal/console window.

After extracting the bot files, follow these steps to set up a virtual environment and install the required dependencies:

  1. Navigate to the Extracted Folder: Open Terminal (or Command Prompt on Windows) and navigate to the folder where you extracted the bot files. 
    cd path/to/extracted/folder
  2. Create a Virtual Environment: 
    python3 -m venv venv

  3. Activate the Virtual Environment:

    • Windows: 
      venv\Scripts\activate
    • macOS/Linux: 
      source venv/bin/activate

  4. Start the bot: 

    nox -s srv

    Optional: Install nox

    If you're getting "Unknown command: nox" error, you need to install nox first: 

    pip install nox

    The bot will take some time to download its dependencies and should be up and running.

    If you need help, open a ticket on GitHub and we will navigate you.