Setup Guide

Install Python

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

Install Lavalink

Note

Lavalink is essential for processing and streaming audio to Discord. Without a Lavalink server, you won't be able to play music on Vocard. You can either host your own server or use a public Lavalink server from this Public Lavalink Website.

• Vocard requires Lavalink v4.
• For detailed steps on installing Lavalink, visit the Lavalink Offical Website.

Download Vocard Bot

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.

with docker recommended

Utilizing the official Docker image enables a quick setup, as it conveniently includes all necessary dependencies. To get started, simply pull the image using a terminal command:

Docker HubGithub

docker pull chocomeow/vocard:v2.6.9

docker pull ghcr.io/chocomeow/vocard:v2.6.9

1. Configure the bot before starting the docker containers.
2. Start the Docker containers in detached mode:

   docker-compose up -d
   

Configuration

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

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