Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pkg-dot-zip/welcomeemojidiscordbot

An emoji-welcoming Discord bot written in Kotlin using Kord.
https://github.com/pkg-dot-zip/welcomeemojidiscordbot

bot discord discord-bot emoji emojis kord kotlin kotlin-jvm

Last synced: 10 days ago
JSON representation

An emoji-welcoming Discord bot written in Kotlin using Kord.

Awesome Lists containing this project

README

        



Project logo

WelcomeEmojiDiscordBot

[![Stars](https://img.shields.io/github/stars/pkg-dot-zip/WelcomeEmojiDiscordBot.svg)](https://github.com/pkg-dot-zip/WelcomeEmojiDiscordBot/stargazers)
[![GitHub Issues](https://img.shields.io/github/issues/pkg-dot-zip/WelcomeEmojiDiscordBot.svg)](https://github.com/pkg-dot-zip/WelcomeEmojiDiscordBot/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/pkg-dot-zip/WelcomeEmojiDiscordBot.svg)](https://github.com/pkg-dot-zip/WelcomeEmojiDiscordBot/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

---

An emoji-welcoming Discord bot written in Kotlin using Kord.


## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Built Using](#built_using)
- [Authors](#authors)

## 🧐 About
**WelcomeEmojiDiscordBot** is a [Discord](https://discord.com/) bot for welcoming users by reacting to it with an emoji, programmed in [Kotlin](https://kotlinlang.org/) using [Kord](https://github.com/kordlib/kord). I created this because one of my friends needed it. The bot itself is quite simple; everything was setup and running in an hour.

You need to run this bot yourself, since I don't host it anywhere. Fortunately, this is a very simple task.

## 🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites
What things you need to install the software. If you are a developer already you probably have these components installed.

- An IDE for Kotlin development. I used IntelliJ Ultimate Edition _(2023.3.2)_, and recommend you use [IntelliJ](https://www.jetbrains.com/idea/download/?section=windows) as well.
- Java installed. This project targets version 19 on the JVM.

### Installing
A step by step series of examples that tell you how to get a development env running.

1. Enable the developer mode for you account in your Discord application (this can also be done on mobile).
2. Go to the [developer portal](https://discord.com/developers/applications).
3. Create a new application. Make sure to name the bot appropriately.
4. Navigate to the “Bot” tab to configure it.
5. Create a ".env" file in the top of the project directory.
6. Put variables for _TEST_SERVER_ & _TOKEN_. _TEST_SERVER_ being your server's ID & _TOKEN_ being your bot's token from your developer portal. If this step confuses you check out [this](https://github.com/Kord-Extensions/template) page.
7. Change the *val EMOJI* in *App.kt*.
8. Run the project.

## 🎈 Usage
Use _/emojiStop_ to stop the bot.

## ⛏️ Built Using
- [Kotlin](https://kotlinlang.org/) - Language used to program the bot in
- [Kord](https://github.com/kordlib/kord) - Modularized implementation of the Discord API
- [Kord Essentials Template](https://github.com/Kord-Extensions/template/) - Template used

## ✍️ Authors
- [@OnsPetruske](https://github.com/pkg-dot-zip) - Idea & Initial work

See also the list of [contributors](https://github.com/pkg-dot-zip/WelcomeEmojiDiscordBot/contributors) who participated in this project.