About This File
# YOU CANNOT REMOVE ANY CREDITS!!!!
# YOU CANNOT REMOVE ANY CREDITS!!!!
# YOU CANNOT REMOVE ANY CREDITS!!!!
# YOU CANNOT REMOVE ANY CREDITS!!!!
# YOU CANNOT REMOVE ANY CREDITS!!!!
# Notes
- This bot is **NOT** for resale, this is a public bot, reselling it is breaking the GNU License.
- If using code, or snippets, **YOU MUST CREDIT** `Hyperz#0001` in your bot / project.
---
# Dependencies:
- [Bot Hosting](https://snowsidehosting.com/index.php?rp=/store/discord-bot-hosting) or a [VPS / DPS](https://snowsidehosting.com/index.php?rp=/store/vps)
- MySQL Server (Required)
- [NodeJS V16+](https://nodejs.org/en/) (Required to run the bot)
- [git](https://git-scm.com/downloads) (Required to install node modules)
---
# Install Guide
- Make sure you have downloaded [NodeJS](https://nodejs.org/en/) (get recommended)
- Open the bots folder
- Edit the `config.js` file to match your information
- Create a new database and import the `install.sql` file into a new database.
# Run With .bat
- Run the `CLIENT.bat` file
- Pick what you want to do
# Run With .c
- `make compile` or `make run`
- Run `CLIENT.o`
---
# MySQL
**The bots way of storing data!**
### This includes:
- punishments
- users stats
- sticky messages
- offline bans
- level system data
- birthdays
- giveaways & entrys
- marriages
### Default Code:
```
"mysql": {
"host": "localhost",
"user": "root",
"password": "",
"database": "hypebot"
},
```
- `host` - *The IP of the server hosting the DB*
- `user` - *The user you wish to use on the DB (usually root)*
- `password` - *The password to the user account*
- `database` - *The name of the database you are storing your tables in*
---
# Errors or Problems
Here you can find all of the possible / known errors or problems with that you may come across!
---
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Disallowed Intents](#disallowed-intents)
- [Node Modules Creation](#node-modules-creation-failed)
- [Missing Permissions](#missing-permissions)
- [ECON Refused](#econ-refused)
- [Discord-Canvas](#discord-canvas-issue)
- [Unexpected Token '?'](#unexpected-token-%3F)
- [Abort Controller](#abort-controller)
---
## DISALLOWED INTENTS
- Go to your [Discord Developer Portal](https://discord.com/developers/applications)

- Click on your bot application

- Click the category on the side labeled "bot"

- Scroll down until you find this section:

- Turn "Presence Intent" to `ON`

- Turn "Server Members Intent" to `ON`

- Once you have turned both of those on, simply click **"SAVE CHANGES"** at the bottom

- Then you are finished!!!!!
- Restart your bot, and then give it a shot!
---
## Node Modules Creation Failed
If this error occurs, it likely means you either
- A), You don't have [NodeJS](https://nodejs.org/en/) V16+ installed.
- B), You don't have [Git](https://git-scm.com/downloads) installed.
Installing these should fix this issue!
---
## Missing Permissions
Make sure your bot has Administrator permissions in it's roles, also make sure it is at the top of the roles list, see example below if you need a visual example.
---
## ECON Refused
You have to actually connect to a MySQL server.
---
## Discord Canvas Issue
It looks like a bunch of `Node GYP` Errors, and it is usually spammed in the console.
To fix this issue, follow the below guide.
- Delete the `node_modules` folder inside of the bot.
- Make sure you have updated to [NodeJS V16+](https://nodejs.org/en/).
- Re-run the `CLIENT INSTALL.bat` file.
- Then try starting your bot with the provided client starter file.
---
## Unexpected Token ?
This error occurs when you're not on the latest required version of [NodeJS](https://nodejs.org) (v16+ Required)
---
## Abort Controller
To fix this issue, or issues / errors relating to this, simply [update NodeJS to V16+](https://nodejs.org)
You can check your NodeJS Version by running `node -v` in command prompt, powershell, or terminal.
---
# Getting IDs
- Open your Discord settings
- Scroll down and find "Appearance"
- Scroll to the bottom and find "Developer Mode"
- Turn the switch on
---
# Port Requirement
The bot uses a port so it can simply detect whether or not it is online via a "status" page.

---
# Debug Mode
Debug mode is STRICTLY designed to show the errors the bot has. Most errors will not be sent in console while `debugmode` is set to `false`. This allows users to keep their console clean and collected!
