Setup Guide

Install Python

• Vocard requires Python 3.11 or higher.
• Follow the guidelines here: Installing Python.

Download Vocard Bot

With Docker recommended

Using the official Docker image is the easiest way to set up Vocard, as it includes all necessary dependencies. Follow the guide below to get started, regardless of your platform:

• For Linux and Windows, follow the unified Docker Setup Guide.

This guide provides step-by-step instructions for installing and running Vocard using Docker on both operating systems.

with git

1. Clone the repository:

   git clone https://github.com/ChocoMeow/Vocard.git
   

2. Go to the directory:

   cd Vocard
   

3. Install required packages, ideally by using a virtual environment:

   python -m pip install -r requirements.txt
   

After installing all packages, you must configure the bot before starting.

Configuration

1. Rename settings Example.json to settings.json and customize your settings.

2. Now, you can start your bot with python main.py.