Installation Guide

Follow this step-by-step guide to set up Zeltux on your system

1

Prerequisites

Node.js

Version 16.9.0 or higher required

Git

Latest version recommended

2

Installation

Clone Repository
$ git clone https://github.com/RedolentHalo/Zeltux.git
Copied!
Change Directory
$ cd Zeltux
Copied!
Install Dependencies
$ npm install
Copied!
3

3. Set Up Configuration

terminal
$ npm run setup
Copied!

Configuration Structure

config.json
{
  "token": "",           // Your bot token
  "clientId": "",        // Your application client ID
  "weatherApi": "",      // Weather API key
  "MongoDBURI": "",      // MongoDB connection string
  "logsChannelId": "",   // Channel ID for bot join/leave logs
  "statuses": [
    {
      "type": "Playing",
      "state": "with commands"
    }
  ],
  "lavalink": {
    "host": "",         // Lavalink server host
    "port": 443,        // Lavalink server port
    "name": "",         // Lavalink server name
    "password": ""      // Lavalink server password
  }
}

Bot Token

Get from Discord Developer Portal → Bot → Reset Token

Client ID

Found in Discord Developer Portal → OAuth2 → Client ID

Weather API Key

Required for weather command functionality

MongoDB URI

Database connection string for storing bot data

Lavalink Details

  • • Host address
  • • Port number
  • • Password
  • • SSL setting
4

4. Start the Bot

terminal
$ npm run start
Copied!

Need Help?

If you run into any issues, join our support server:

Join Support Server