Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dxxxxy/dreambot
An open-source hypixel skyblock bot with extensive documentation, the latest dependencies and almost no hardcoding. Featuring simple, clean yet elegant embed messages with custom emojis and database integration.
https://github.com/dxxxxy/dreambot
bot discord hypixel pets profile skills skyblock xp
Last synced: 7 days ago
JSON representation
An open-source hypixel skyblock bot with extensive documentation, the latest dependencies and almost no hardcoding. Featuring simple, clean yet elegant embed messages with custom emojis and database integration.
- Host: GitHub
- URL: https://github.com/dxxxxy/dreambot
- Owner: DxxxxY
- Created: 2020-06-28T03:54:23.000Z (over 4 years ago)
- Default Branch: current
- Last Pushed: 2022-08-27T16:26:45.000Z (about 2 years ago)
- Last Synced: 2023-03-04T21:57:03.831Z (over 1 year ago)
- Topics: bot, discord, hypixel, pets, profile, skills, skyblock, xp
- Language: JavaScript
- Homepage:
- Size: 174 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DreamBot
[Setup](#setup) | [Commands](#commands) | [How it works](#how-it-works) | [Credits](#credits)
### Recode Completed (v2). For the v1, visit [DreamBot/legacy](https://github.com/DxxxxY/DreamBot/tree/legacy)
An open-source hypixel skyblock bot with extensive documentation, the latest dependencies and almost no hardcoding. Featuring simple, clean yet elegant embed messages with custom emojis and database integration.
## Setup
1. Clone repo
2. Create a `.env` file following this template:
```sh
TOKEN= # discord client token
PREFIX= # bot command prefix
APIKEY= # hypixel api key
DATABASE= # mongodb url
```
3. `npm i` - Installs dependencies
4. `node .` - Runs bot
> Congrats, you made it.
## Commands
> Please take note that [] means required while <> means optional (arguments)
- `d!help` - Shows all commands.
- `d!register [IGN]` - Register your name so that subsequent commands don"t need your name.
- `d!timers` - Shows timers for events
> The following commands will display a players stat if given a name. If no name is given and you are registered, you will be displayed your own stats.
- `d!skills ` - Shows skills
- `d!pets ` - Shows pets
- `d!slayers ` - Shows slayers
- `d!info ` - Shows basic info
## How it works
- For command binding:
A command is registered by reading its file name and creating a "copy" of its run function (`exports.run`).
- For alias binding:
An alias is registered by reading the first line of the file and seeing if it has a comment (`//`). It will then parse that command and whatever text written shall be registered as an alias that can be called like a command.
As an example: imagine a file named `help.js` in the `commands/` directory. The content of that file is:
```js
//h
exports.run = (client, message, args) => {
message.channel.send("help")
}
```
Two commands will be registered, `h` and `help` prefixed with whatever the value of `process.env.TOKEN` is.
- For event binding:
An event is registered by reading its file name and exporting it with `module.exports`.
As an example: imagine a file named `ready.js` in the `events/` directory. The content of that file is:
```js
module.exports = (client) => {
console.log(`Logged in as ${client.user.tag}`)
}
```
```diff
+ As a plus, we get to access `client`, `message` and `args` without
+ having to import them.
+ And, as we already have an enclosing function, we can simply prefix the
+ arguments with async instead of creating a self executing anonymous function.
- As a minus, commands and events are REQUIRED to be in `commands/`
- and `events/` respectively and their names will need to adhere to discord.js.
```
A list of events can be found here: https://discord.js.org/#/docs/main/stable/class/Client
## Credits
- [InventiveTalent](https://github.com/InventivetalentDev) - Event Timers API
- [Hypixel-Skyblock Wiki](https://hypixel-skyblock.fandom.com/wiki/Hypixel_SkyBlock_Wiki) - Media, XP tables, Info
- [Minetools](https://api.minetools.eu/) - Minecraft API
- [Visage](https://visage.surgeplay.com/index.html) - Skins API
- [Hypixel](https://api.hypixel.net/) - Hypixel API