{"id":19227663,"url":"https://github.com/dxxxxy/dreambot","last_synced_at":"2025-04-21T01:31:41.025Z","repository":{"id":43861669,"uuid":"275502476","full_name":"dxxxxy/DreamBot","owner":"dxxxxy","description":"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.","archived":false,"fork":false,"pushed_at":"2023-08-31T01:34:18.000Z","size":211,"stargazers_count":4,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"current","last_synced_at":"2025-04-01T07:54:06.956Z","etag":null,"topics":["bot","discord","hypixel","pets","profile","skills","skyblock","xp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dxxxxy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-28T03:54:23.000Z","updated_at":"2023-07-25T12:20:50.000Z","dependencies_parsed_at":"2022-09-02T04:31:04.361Z","dependency_job_id":null,"html_url":"https://github.com/dxxxxy/DreamBot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxxxxy%2FDreamBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxxxxy%2FDreamBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxxxxy%2FDreamBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxxxxy%2FDreamBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dxxxxy","download_url":"https://codeload.github.com/dxxxxy/DreamBot/tar.gz/refs/heads/current","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249982520,"owners_count":21355707,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","discord","hypixel","pets","profile","skills","skyblock","xp"],"created_at":"2024-11-09T15:24:24.712Z","updated_at":"2025-04-21T01:31:40.707Z","avatar_url":"https://github.com/dxxxxy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DreamBot\n\n[Setup](#setup) | [Commands](#commands) | [How it works](#how-it-works) | [Credits](#credits)\n\n### Recode Completed (v2). For the v1, visit [DreamBot/legacy](https://github.com/DxxxxY/DreamBot/tree/legacy)\u003chr\u003e\n\nAn 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.\n\n## Setup\n1. Clone repo\n2. Create a `.env` file following this template:\n```sh\nTOKEN= # discord client token \nPREFIX= # bot command prefix\nAPIKEY= # hypixel api key\nDATABASE= # mongodb url\n```\n3. `npm i` - Installs dependencies\n4. `node .` - Runs bot\n\u003e Congrats, you made it.\n\n## Commands\n\u003e Please take note that [] means required while \u003c\u003e means optional (arguments)\n- `d!help` - Shows all commands.\n- `d!register [IGN]` - Register your name so that subsequent commands don\"t need your name.\n- `d!timers` - Shows timers for events\n\u003e 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.\n- `d!skills \u003cIGN\u003e` - Shows skills\n- `d!pets \u003cIGN\u003e` - Shows pets\n- `d!slayers \u003cIGN\u003e` - Shows slayers\n- `d!info \u003cIGN\u003e` - Shows basic info\n\n## How it works\n- For command binding: \nA command is registered by reading its file name and creating a \"copy\" of its run function (`exports.run`).  \n\n- For alias binding:\nAn 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.\n\nAs an example: imagine a file named `help.js` in the `commands/` directory. The content of that file is:\n```js\n//h\nexports.run = (client, message, args) =\u003e {\n    message.channel.send(\"help\")\n}\n```\nTwo commands will be registered, `h` and `help` prefixed with whatever the value of `process.env.TOKEN` is.\n\n- For event binding:\nAn event is registered by reading its file name and exporting it with `module.exports`.\n\nAs an example: imagine a file named `ready.js` in the `events/` directory. The content of that file is:\n```js\nmodule.exports = (client) =\u003e {\n    console.log(`Logged in as ${client.user.tag}`)\n}\n```\n\n```diff\n+ As a plus, we get to access `client`, `message` and `args` without \n+ having to import them. \n\n+ And, as we already have an enclosing function, we can simply prefix the  \n+ arguments with async instead of creating a self executing anonymous function.\n\n- As a minus, commands and events are REQUIRED to be in `commands/` \n- and `events/` respectively and their names will need to adhere to discord.js.\n```\n\nA list of events can be found here: https://discord.js.org/#/docs/main/stable/class/Client\n\n## Credits\n- [InventiveTalent](https://github.com/InventivetalentDev) - Event Timers API\n- [Hypixel-Skyblock Wiki](https://hypixel-skyblock.fandom.com/wiki/Hypixel_SkyBlock_Wiki) - Media, XP tables, Info\n- [Minetools](https://api.minetools.eu/) - Minecraft API\n- [Visage](https://visage.surgeplay.com/index.html) - Skins API\n- [Hypixel](https://api.hypixel.net/) - Hypixel API","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdxxxxy%2Fdreambot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdxxxxy%2Fdreambot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdxxxxy%2Fdreambot/lists"}