Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pkg-dot-zip/qrcodediscordbot
A QR-code generating Discord bot written in Kotlin using Kord.
https://github.com/pkg-dot-zip/qrcodediscordbot
bot discord discord-bot kord kotlin kotlin-jvm qrcode
Last synced: 10 days ago
JSON representation
A QR-code generating Discord bot written in Kotlin using Kord.
- Host: GitHub
- URL: https://github.com/pkg-dot-zip/qrcodediscordbot
- Owner: pkg-dot-zip
- License: mit
- Created: 2024-01-05T12:08:36.000Z (10 months ago)
- Default Branch: root
- Last Pushed: 2024-02-10T11:00:34.000Z (9 months ago)
- Last Synced: 2024-02-10T12:20:48.719Z (9 months ago)
- Topics: bot, discord, discord-bot, kord, kotlin, kotlin-jvm, qrcode
- Language: Kotlin
- Homepage:
- Size: 381 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
QRCodeDiscordBot
[](https://github.com/pkg-dot-zip/QRCodeDiscordBot/stargazers)
[](https://github.com/pkg-dot-zip/QRCodeDiscordBot/issues)
[](https://github.com/pkg-dot-zip/QRCodeDiscordBot/pulls)
[](/LICENSE)
---
A QR-code generating 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
**QRCodeDiscordBot** is a [Discord](https://discord.com/) bot for generating QR-codes, programmed in [Kotlin](https://kotlinlang.org/) using [Kord](https://github.com/kordlib/kord). I created this because of my unwarranted love for QR-codes & Kotlin, while also wanting to learn how to create Discord bots due to the increasing demand of these bots. 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 17 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. Run the project.
## 🎈 Usage
Use _/qrgen [CONTENTS]_ to generate a QR-code of the given content.
Use _/qrstop_ 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
- [QR code API](https://goqr.me/api/) - API used for retrieving QR-codes
## ✍️ Authors
- [@OnsPetruske](https://github.com/pkg-dot-zip) - Idea & Initial work
See also the list of [contributors](https://github.com/pkg-dot-zip/QRCodeDiscordBot/contributors) who participated in this project.