Starting your bot

There are multiple possibilities to start your bot. On this page you'll find information about how to start your bot using Pterodactyl and how to host it locally on your own computer/laptop.

Enabling the required intents

Zyno Bot requires some priviliged intents. You're probably wondering "what are these priviliged intents?". Well, these intents make sure that your bot receives the right data so you can use your welcome/leave messages, manage your members, use your message commands and make sure your bot can filter all the blacklisted words. So yeah it's pretty important to enable these. These are pretty easy to enable. The first thing you need to do is go to your developer portal which you can find here. You'll see the following screen if you're logged in:

You need to select your application on this page which you've made in Getting your token. In the example above it's Zyno Bot, for you it's probably something different. When you open your application you'll see the following screen:

When you see this page, you need to click the Bot button in the menu at the right side.

The page you'll see will look something like the screen you see above. When you see this you need to scroll a bit down until you see the Privileged Gateway Intents. You'll see the following once you do this:

Make sure to enable the options with the red circle around them. After you've enabled these, don't forget to save your changes. After you've saved it, they're enabled and you're done with this part!

Getting your bot online

There are multiple ways to get your bot online. Most people use a Pterodactyl panel, which is a panel where you can easily manage your VPS and split your VPS in multiple servers. There are also a lot of hosting companies that offer Discord bot hostings. These hostings often also make use of Pterodactyl. You can also host it on your own PC, although we'd rather recommend you to host the bot on a hosting or VPS.

Hosting

The most Discord bot hostings make use of Pterodactyl. When you're using a Discord bot host that makes use of the Pterodactyl panel, you need to be sure that it's a NodeJS server. Most hostings ask you when you're about to buy the hosting, in what language you want to host the bot. Make sure you've selected here NodeJS, DiscordJS or something which relates to one of these options. After you've bought it, you can login to the hosting's Pterodactyl panel (mostly called Game Panel), and here you can select your Discord bot hosting. At the File Manager you can upload all the files of the bot. After uploading them, you need to set the bot up manually with the config.json file. Read here more about setting up the config.json file.

Pterodactyl

If you're using Pterodactyl, you'll need an egg to run NodeJS (the language the bot is written in). You can use the NodeJS egg which is included in the /files folder or use your own egg. To use the egg, follow the following steps:

  1. Go to your Pterodactyl panel

  2. Click the admin settings button

  3. Click the Nests button on the sidebar

4. Click the 'Upload Egg' button at the right top

5. Select your egg and upload it

6. Create a server and select the NodeJS egg

It's recommended to have at least 256 megabyte for your RAM and 600 megabyte for your diskspace. After you've created your server, you can upload your files to the server. To upload the files, you need to unzip them locally and upload all the files with the SFTP to your server. Some good SFTP clients to use are:

You can find your SFTP details by going to your Pterodactyl server -> Settings. When you log in with these credentials, you can just drag all the files to your Pterodactyl server in your SFTP client.

After you've uploaded all the files, you need to set up the config.json file manually. Click here to see how to change the config.json.

Locally

If you're hosting your bot locally, you'll need to install NodeJS from the official NodeJS website. Install version 18.19.0 or higher if you haven't installed it already.

Make sure to check the chocolatey checkbox during the installation of NodeJS if you're using Windows.

If the installation of NodeJS with the chocolatey checkbox enabled on your Windows device resulted in an error/multiple errors, please follow the alternative installation.

After installing it, you can unzip the files to a folder where you want to locate the bot. This must be a folder without any other files in it. After you've done that, you'll need to open the console and execute the following command:

If you're using Windows: npm install --global --production --vs2015 --add-python-to-path windows-build-tools

If you're using Debian/Ubuntu: apt-get install autoconf automake g++ libtool build-essential

If you're using CentOS: sudo yum groupinstall "Development Tools"

If you're using MacOS:

  1. Install Brew if you've haven't installed it with the following command /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

  2. Install autoconf, automake and libtool if you haven't installed it with the following command brew install autoconf automake libtool

More information

When you've executed the command, you need to go to the folder location using the command cd YOUR FILE LOCATION HERE. When you've done this, you can run the command node .. The script will start up and ask for some information so it will autocomplete the config by itself. You can also do this manually but you don't need to. The things the script will ask for are:

  • Your bot token (See here how to get your bot token)

  • The prefix of the bot (The prefix is the sign before the command names so the bot knows when it should react on a command and when not)

  • Your license key (You receive this after requesting it)

  • Your license activation key (Your receive this with your license key)

  • A password to activate your license (After your license has been activated, your license can only be used with this password)

If your bot shuts down, you can start it up again by running the command node ..

Change the config manually

You need to change the following things in your config.json:

  • "token": null: Change the Your Token Here part to your bot token. (See Getting your token to see how you get your bot token)

  • "prefix": null: Change the Your Prefix Here part with the prefix of your bot (The prefix is the sign before the command names so the bot knows when it should react on a command and when not)

  • "license": Click here to get more information about requesting a license

    • "key": null: The license key you've received after requesting it.

    • "activationKey": null: The activation key you've received after requesting your license.

    • "password": null: A password which will be added to your license after your license is being used for the first time.

Make sure to put quatation marks around every value you add

Installing packages

By default all the packages will be installed. You can disable this by setting the autoInstallation to false in the config.json file. If you've set the autoInstallation to true, the packages will automatically be installed when you start up the bot. It will also always check if you have the right packages installed and the right versions. If not, the missing package will be installed.

Manual installation

Zyno Bot requires a few packages. The easiest way to install them is running the npm i command.

You can also install them one by one. You need to install the following packages:

If you're installing the packages manually and want to upload the packages to a server, please make sure that your server is running the same operating system as your pc/laptop. If not, please use the automatic installation.

The installation

After you've completed the config, the script will activate your license. After it activated your license, it will download all the bot files which are saved on another server. After downloading the zip from the server, the script will unzip it so the files can be used. When the script has completed this, it will automatically start up your bot. If there are any errors during the process you will see it in the console. If you don't understand the error, please contact us.

Do not stop the process while the script is installing!

Inviting your bot

It's important to invite your bot after you start your bot. To invite your bot, you'll need to follow the following steps

  1. Go to https://discord.com/developers

  2. Select your application

  3. Copy the ID underneath the APPLICATION ID text

  4. Change the [APPLICATION ID HERE] part in the url below with the ID you've copied

  5. Go to that url and invite your bot

  6. The owner of the application (probably you), will receive a DM of the bot and will be asked to allow the bot to start working in the server or not. The owner must allow this in order for the bot to start working.

https://discord.com/oauth2/authorize?client_id=[APPLICATION ID HERE]&scope=applications.commands+bot&permissions=8

Transfering your bot

If you want to transfer your bot to a different hosting or want to host it locally, it's important that you copy every file of the bot. To do this, you need to select all the files and make a ZIP file of it. Then you can download this file and upload it to the hosting where you want to transfer your bot to. After doing this, you need to select the file and unzip it. After unzipping it, you can start your bot and it should work again. If it does not work, we recommend you to contact us.

It's not recommended to use the built-in back up command to transfer your bot.

PreviousBefore you startNextAlternative installation

Last updated