Skip to content

pkg-dot-zip/QRCodeDiscordBot

Repository files navigation

Project logo

QRCodeDiscordBot

Stars GitHub Issues GitHub Pull Requests License


A QR-code generating Discord bot written in Kotlin using Kord.

📝 Table of Contents

🧐 About

QRCodeDiscordBot is a Discord bot for generating QR-codes, programmed in Kotlin using 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 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.
  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 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

✍️ Authors

See also the list of contributors who participated in this project.

About

A QR-code generating Discord bot written in Kotlin using Kord.

Topics

Resources

License

Stars

Watchers

Forks

Languages