pan-nav / ls-bot

The Discord bot powering the LearnSpigot.com support server.

LearnSpigot Discord Bot

This is the Discord bot for the LearnSpigot Discord Server. LearnSpigot is the most sold Minecraft course in the world, and this bot aids the provision of exclusive support for all students in the server.

This bot powers systems such as verification, tickets and suggestions.

Technologies

Written in Kotlin/JVM. Using Gradle (Kotlin DSL) build tool.

Libraries

• JDA (Java Discord API)
• MongoDB Java Driver (Database)
• Neptune (Command framework)

Contributing

Contributions are always welcome. If you have no coding knowledge, please create an issue in the Issues tab so we can track it. Otherwise, please use the following steps to begin contributing to the code:

1. Fork the repository, and then clone it to your local git
2. Open the project in your IDE of choice
3. We use environment variables for sensitive data such as Mongo URI's and bot tokens, as well as constants such as channel IDs or role IDs. You will see an .env.example in the root folder. You should rename this to .env, and populate it.
4. Before making changes, familiarise yourself with Flyte's Contributing Guidelines
5. Make your changes, and please maintain a similar code style and quality
6. Create a Pull Request into the master branch of this repository

We review pull requests as soon as possible. Please feel free to get in touch if it's urgent.

If you are an active contributor or close to the Flyte team, you may be offered access to the official LearnSpigot bot testing server where preconfigured .env files are provided with bot tokens and a database. Otherwise, all the tools are provided to work locally.