https://github.com/hellsnakes/the-beautiful-bot

An osu! bot for Discord
https://github.com/hellsnakes/the-beautiful-bot

Last synced: 25 days ago
JSON representation

An osu! bot for Discord

• Host: GitHub
• URL: https://github.com/hellsnakes/the-beautiful-bot
• Owner: HELLSNAKES
• License: mit
• Created: 2021-05-15T08:35:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T09:34:45.000Z (about 2 years ago)
• Last Synced: 2024-11-01T23:03:06.748Z (2 months ago)
• Language: TypeScript
• Homepage: https://the-beautiful-bot.netlify.com/
• Size: 25.2 MB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/Moorad/the-beautiful-bot?style=flat-square) ![GitHub issues](https://img.shields.io/github/issues/Moorad/the-beautiful-bot?style=flat-square) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/Moorad/the-beautiful-bot?style=flat-square)

![Travis (.com)](https://img.shields.io/travis/com/Moorad/the-beautiful-bot?style=flat-square)

### Um, what is this

This is a bot that I developed because why not :)

1. To get this bot running on your machine first you will have to have [Node.js](https://nodejs.org/en/)

2. (Windows only) For the module "canvas", that is heavily used in this project, to work you will have to install several dependencies [[Installation]](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows). An easier way to install all the dependencies on your devices is to use [Chocolatey](https://chocolatey.org/) which is also explained at the bottom of the [installation guide](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows#install-with-chocolatey)

3. Run `git clone https://github.com/mooradal/The-Beautiful-Bot.git` on your command line in the directory you want the files to be cloned to or download the files from Github

4. Run `npm install` to install the modules required

5. create a file called ".env" and fill it with the following information:

```

discordAPI = [Your Bots Discord Token]

osuAPI = [your osu! api key]

dbURI = [your MongoDB Database's URI]

prefix = [prefix] (Only if you want to have a different prefix)

```

Alternatively these values can be passed as environment variables

Note that the bot was not developed to be user friendly. A better setup process will be implemented in the future.

6. You are good to go. You can run `node index.js` to run the bot.

If you find any bugs please contact me (or open an [issue on github](https://github.com/Moorad/the-beautiful-bot/issues))