Installing BuiltBotBase

Prerequisites

Before you begin, make sure you have the following installed on your system:

• Python (version 3.6 or higher(probably?))

Installing Poetry

Poetry is a dependency management and packaging tool for Python. To install Poetry using the official installation script, follow these steps:

For more information and detailed installation instructions, visit the Poetry website.

1. Open your terminal or command prompt.
2. Run the following command to install Poetry:
   • For Linux/macOS:

     curl -sSL https://install.python-poetry.org | python3 -

   • For Windows (PowerShell):

     (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

     Note: If you installed Python from the Microsoft Store, replace py with python in the command above.

Installing Project & Dependencies

To install the dependencies of this already existing project using Poetry, follow these steps:

0. Clone the Repository

   git clone https://github.com/pixDeVl/BuiltBotBase.git

   Alteratively, download the repository as a zip file and extract it to your desired locaition.

1. Navigate to your project directory:

   cd BuiltBotBase

2. Run the following command to install the project dependencies:

   poetry install --no-root

   Poetry will read the pyproject.toml file and install the specified dependencies.

Set up

Bot Token

To run the bot, you need to have a bot account to connect through. To login to said bot account, you need to provide the token. If you don't have one, you can create a new bot and get the token from the Discord Developer Portal. For a comprehensive guide on how to create a bot account and obtain a token, visit the Discord Developer Portal documentation.

Once you have the token, create a .env file in the root of the project(BuiltBotBase/, on the same level as start.py, config.toml, ect) and add the following line to it:

BOT_TOKEN=<your_token_here>

Running the Bot

To start the bot after adding the authentication token, simply run the following command in the terminal:

poetry run python start.py