kasperbosteels / little_korean_rice_cooker

this is my discord bot, ive been working on it from time to time, its more a thing to keep me busy on slow days.

keep in mind when discord updates, certain things might break.

Little_Korean_Rice_Cooker

An overly convoluted discord bot, with a ton of features.

Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Versions
  • Installation
• Usage
• License
• Authors
• Acknowledgements

About The Project

If you are a frequent visitor of the popular chat app Discord, you might already know that there are a ton of user made bots for all kinds of purposes. As an experiment i made my own Discord bot with just some minor functionalities, to be used as a test bed for my javascript skils. Over the years the bot has grown and more people started using it, so now i have it running almost 24/7 and periodically update its code as my expertise in javascript grows. this is by no means a serious project yet, so do not expect frequent updates.

Why would you get this bot for your server? Here's why:

• This bot has very easily configured.
• This bot likes to have fun just like you.
• There are a ton of fun commands you can try out.
• level progression
• Slash commands
• handy auto moderation features.
• music player with your own playlists with no limits

I hope you consider running or inviting my bot, i am always open for questions or feature suggestions.

Built With

• discord.js
• discord.js/voice
• oxford api
• urban dictionary api
• programmable google search engine
• mysql
• typeorm
• yt-core

Getting Started

How to run this project localy:

Prerequisites

stuff you need to install FIRST!

• node 16.13.2
• npm (i use 8.1.2 as of 2023)
• ffmpeg.
• the discord bot token.
• a MySql server.
• pm2

Versions

LTS

V14

old(unsuported)

V12
V13

Installation

simple installation in 3 steps:

1. Clone the repo

git clone https://github.com/KasperBosteels/Little_Korean_Rice_Cooker.git

2. Install NPM packages(may take a while).

npm install

3. Create a .env file with the following enviroment variables

• DISCORD_TOKEN=ENTER YOUR DISCORD TOKEN
• SERVER_PASSWORD=YOUR SQL SERVER PASSWORD
• SERVER_USER=YOUR SQL SERVER USERNAME
• DATABASE=THE DATABASE IN YOUR SQL SERVER
• HOST=SQL SERVER IP ADDRESS OR HOSTNAME
• TYPE=THE TYPE OF YOUR SERVER IN MY CASE THIS WAS "mysql"
• PORT=PORT USUALLY THIS IS 3306 BUT THIS MIGHT BE DIFFERENT FOR YOU
• OXFORD_ID=ID FROM THE OXFORD API
• OXFORD_KEY=API KEY FOR THE OXFORD API
• OXFORD_LANG=THE PREFFERED LANGUAGE
• OXFORD_URL=ttps://od-api.oxforddictionaries.com/api/v2
• CSE_ID=ID FOR THE PROGRAMMABLE GOOGLE SEARCH ENGINE
• GOOGLE_API_KEY=API KEY FOR THE GOOGLE SEARCH ENGINE

where to get the key's and id's?

- The discord token can be created in [the discord developers platform](https://discord.com/login?redirect_to=%2Fdevelopers%2Fapplications)

• The sql credentials you will need to create on your own after setting up an sql server.

• The oxford keys can be attained from the oxford dictionaries api website you will need to create an account there and follow the simple instructions there. (attention oxford api has started limiting usage of free account you will only get 1000 total requests before you need to pay.)

• For the programmable search engine (the CSE_ID) you will need to create one in googles programmable search engine dashboard

• For the google-api key you will need to create a new project in the google cloud platform and get the google_api key from there.

this should be all.

Usage

with your terminal navigate to the "Little_Korean_Rice_Cooker" directory.

• windows: use "npm start" to start the bot.
• linux: use "pm2 start bot.js" to start the bot.

License

Distributed under the CC0 License. See LICENSE for more information.

Authors

• Kasper - Programming Student - Kasper - whell i made it on my own.