Hex Docs
HomeHex AuthStatus
  • Welcome
  • Post install
    • Ubuntu Server Setup
    • Debian 12 Server Setup
    • Windows Server Setup
  • App Setup
    • Hex Status 2.0
    • Hex Status
    • Hex Web
    • Hex Bot
  • Updating
    • Upgrade/Update Guide
Powered by GitBook
On this page
  • Prerequisites
  • Step 1: Install Dependencies
  • Step 2: Run the Setup Wizard
  • Step 3: Starting Hex Bot
  • Troubleshooting
  1. App Setup

Hex Bot

Welcome to the Hex Bot setup guide! This document will help you configure your system and prepare Hex Bot for operation.


Prerequisites

Before starting, ensure you have the following installed on your system:

  1. Node.js (v14 or higher)

  2. npm (Node Package Manager)

  3. A valid license key


Step 1: Install Dependencies

Hex Bot requires several dependencies to function. The setup process will automatically handle missing packages, but you can install them manually if needed:

Install Colors Package

The script first installs the colors package if it isn't already present:

npm install colors

Install Remaining Dependencies

To install all required dependencies, run:

npm install

Step 2: Run the Setup Wizard

The setup wizard will guide you through configuring the bot. To start the wizard, run:

node setup.js

Wizard Steps

1. Authentication Configuration

  • License Key: Enter the license key provided during purchase or registration. The wizard will verify your license key. If authentication fails, you will need to re-enter a valid key.

2. Bot Configuration

  • Discord Bot Token: Enter your bot token. This is required for the bot to operate.

  • Bot Client ID: Enter the client ID associated with your bot.

3. System Configuration

  • Port Number: Specify the port number on which the application will run (default: 3000).

  • Bot Owner ID: Enter the user ID of the bot's owner.

4. Embed Configuration

Customize the appearance of your bot's embeds:

  • Default Embed Color: Enter a hex color code (e.g., #ff0000).

  • Default Embed Footer Text: Specify the footer text for bot messages.

  • Footer Icon URL: Provide a URL for the footer icon (optional).

5. Directory Structure

The setup script automatically creates the following directories if they do not already exist:

  • commands

  • events

  • addons

  • core

6. Saving Configuration

The configuration is saved to a config.yml file in the root directory. This file contains all settings in YAML format.


Step 3: Starting Hex Bot

Once the setup is complete, you can start Hex Bot with the following command:

npm start

Your bot will now be operational.


Troubleshooting

  1. Dependency Issues:

    • Run npm install to ensure all required packages are installed.

  2. Authentication Errors:

    • Verify your license key and network connectivity.

  3. Configuration Errors:

    • Delete config.yml and re-run the setup wizard.

  4. Directory Creation Issues:

    • Ensure your user account has write permissions for the project directory.


Thank you for choosing Hex Bot! For further assistance, contact support or consult the documentation.

PreviousHex WebNextUpgrade/Update Guide