Skip to content

DockerFodes/Ket

Repository files navigation

⭐ Ket Discord Bot ⭐

✨ Ket WAS a shitty discord bot made in TypeScript using Eris ✨

⚠️ » Ket is NO LONGER in development


How to install 🤔

1 - 🛠️ Download and install the necessary tools to get started

If you want to run Ket on your machine, you'll need to:

⚠️ » Recommended version: 14.21.1

⚠️ » Recommended version: 3.3.0

⚠️ » Recommended version: 14 or higher

⚠️ » Lavalink is required for music commands

⚠️ » Java 13 is required to run Lavalink, Java 14 is not recommended

2 - 📁 Download the above frameworks and clone the repository:

git clone https://github.com/KetDiscordBot/Ket # Download this repository

3 - 🧰 Install the necessary dependencies to run the project:

⚠️ » If you don't have yarn installed, install corepack before continuing: "corepack enable"

cd Ket
npm install # Download and build dependencies
yarn # Install all dependencies on yarn

4 - 🌿 Preparing the environment

⚠️ » If you use vscode editor you will need to install yarn SDK:

yarn dlx @yarnpkg/sdks vscode # Open a .ts file, type Ctrl + Shift + P and change the TypeScript version
  • Rename the file ".env.example" to ".env"
  • Replace or fill in ".env" and "settings.json" settings

💡 » settings.json is located in "src/JSON/settings.json"

5 - 🚀 Getting Started

To get started, just type:

# Starting Lavalink: (you can skip it)
java -jar Lavalink.jar # Watch out! Lavalink can consume a lot of RAM
# in a separate terminal:
yarn prod

⚠️ » To skip compilation use yarn start, but you need to build the project first


I Hope you like the project :)

About

✨ Ket is a shitty discord bot made in TypeScript using Eris ✨

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •