Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonaskroedel/orangedb

Discord.js Bot with mySQL integration
https://github.com/jonaskroedel/orangedb

bot discord discord-bot discord-js discord-js-bot discord-js-bots javascript mysql

Last synced: about 1 month ago
JSON representation

Discord.js Bot with mySQL integration

Host: GitHub
URL: https://github.com/jonaskroedel/orangedb
Owner: jonaskroedel
License: gpl-3.0
Created: 2022-04-04T18:13:19.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2023-03-09T17:47:58.000Z (over 1 year ago)
Last Synced: 2024-09-24T12:02:48.680Z (about 2 months ago)
Topics: bot, discord, discord-bot, discord-js, discord-js-bot, discord-js-bots, javascript, mysql
Language: JavaScript
Homepage: https://discord.com/api/oauth2/authorize?client_id=845681260567068712&permissions=8&scope=bot
Size: 96.6 MB
Stars: 5
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Orange Discord Bot

A multi-Guild usable Discord bot built with discord.js

About
•
Features
•
Installation
•
Setting Up
•
License
•
Credits
•
Commands

The orange [ˈɔrɪndʒ] is a round, sweet fruit with a thick orange skin and an orange core, which is divided into many parts.

Or·ange [the]: A fruit

## About

Orange is an open source, customizable Discord bot that is constantly growing. The Bot comes packaged with a variety of commands. The Bot's codebase also serves as a base framework so everyone can easily create a Discord Bot of all kinds and needs. You can invite Orange to your Discord server using [this](https://discord.com/api/oauth2/authorize?client_id=845681260567068712&permissions=8&scope=bot) link! Also, you can join my Server [Funf](https://discord.gg/EejzQcpMHG) for questions, suggestions, assistance and much more.

If you like this repository, feel free to leave a star ⭐ to help promote Orange!

You can find a detailed information sheet with all commands [here](https://github.com/jonaskroedel/OrangeDB/blob/master/COMMANDS.md#detailed-page-for-all-commands).

## Features

``34`` commands across ``4`` different categories!

- ``main`` commands like `meme`, `help`
- ``moderation`` commands like `clear`, `clearchannel`, `prefix`, `userinfo` and much more
- ``music`` commands like `play`, `lyrics`, `24/7`, `autoplay`, `skip` and much more
- ``playlist`` commands like `create`, `load` and much more!

## Installation

You can add Orange to your server with [this](https://discord.com/api/oauth2/authorize?client_id=845681260567068712&permissions=8&scope=bot) link! Alternatively, you can clone this repository and host the bot yourself.

````
git clone https://github.com/jonaskroedel/orangedb
````

After cloning, run these commands

````
npm install
npm install discord.js
npm install dotenv --save
npm install --save mysql2
npm install [email protected]
npm install lyrics-finder
npm install canvas
npm install menudocs/erela.js#build
````

to get all the dependencies and packages. You need [Node.js](https://nodejs.org/) and [MySQL](https://www.mysql.com/) installed. I highly recommend to install [nodemon](https://www.npmjs.com/package/nodemon) as it makes testing *much* easier.

## Setting Up

You have to create a ``.env`` file in your root directory to run the bot (you can use the example file provided as a base). Your file should look something like this:

````
BOT_TOKEN=YOURTOKEN
DB_HOST=YOUR_HOST_ADRESS //eg. localhost
DB_USER=YOUR_DB_USER //eg. root
DB_PASS=YOUR_DB_PASSWORD //eg. root
DB_NAME=orangedb //if you dont know, then do not change that!
HOST=YOU_LAVALINK_HOST
PASSWORD=YOUR_LAVALINK_PASSWORD
PORT=YOUR_LAVALINK_PORT
PREFIX=o! //default prefix for orange
````

Visit the Discord [developer portal](https://discordapp.com/developers/applications/) to create an app and use the client token you are given for the `token` option. `ownerId` is your own Discord snowflake.

After that, you have enable `Privileged Intents` on your Discord [developer portal](https://discordapp.com/developers/applications/). You can find these intents under the "Bot" section, and there are two ticks you have to switch on. For more information on Gateway Intents, check out [this](https://discordjs.guide/popular-topics/intents.html#the-intents-bit-field-wrapper) link.

## To-Do

OrangeDB is a continous state of development. New features/updates can come at any time. Some pending ideas are:

- ~~Music~~
- Ticket-System
- Automod
- Autoroles
- Stream alerts

## License

Released under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.

## Credits

- **Jonas Krödel** - *initial work, artwork, idea, implementation and project management* - [github](https://github.com/jonaskroedel)
- **Julian Hoffmann** - *minor helping* - [github](https://github.com/juhom205)
- **Angelo Failoni** - *helping hand and database-design* - [github](https://github.com/BrainFuzz-hub)
- **Mateo Pal** - *artwork, idea* - [reddit](https://www.reddit.com/user/Velocityakavelo)