alan19 / velen

A simple Javacord framework that can get you up and running really fast!

✨ Velen

Aiming to become the Laravel of Javacord; Velen is a framework for Discord bots using Javacord with complete features from hybrid (message and slash commands), slash commands, prefix managers, blacklists, fuzzy command search, cooldowns and many more.

The aim of Velen is to reduce the time it takes for developers to setup a Discord bot without compromising on performance. For a more organized look-through at Velen, please check our GitHub Wiki instead where everything is more organized and easier to read.

🔌 Requirements

Velen only has one requirements and that is the latest Javacord, this will be updated everytime Javacord releases a new patch. Please ensure your Javacord version will be always up-to-date when using Velen!

• Javacord v3.4.0

📚 Wiki & Guide

As of Velen 3.0, the wiki explains not much compared to the examples for building commands and also fetching commands, we highly recommend taking a look at our examples instead to see a good look over how Velen looks:

• MUST READ FIRST
• Hybrid Commands
• Message Commands
• Slash Commands

We highly recommend reading our wiki where everything is explained more in detailed

• Getting Started
• Building Velen Component
• Building Message, Hybrid and Slash Commands
• Mastering Velen Options
• Customizing Prefix Manager
• Customizing Messages
• Customizing Cooldowns
• Blacklist or Ignoring Users
• Fuzzy Command Suggestion
• Simple Pagination
• Velen Utilities

✔️ Ping-Pong Example

All examples are located at the examples folders below.

• MUST READ FIRST
• Hybrid Commands
• Message Commands
• Slash Commands

❤️ Installation

You can install Velen from Maven Central, otherwise known as Sonatype, which also hosts Javacord and many other libraries.

📦 Maven

<dependency>
    <groupId>pw.mihou</groupId>
    <artifactId>Velen</artifactId>
    <version>3.1.1</version>
</dependency>

📦 Gradle

implementation 'pw.mihou:Velen:3.1.1'

⛰️ Velen is used by

• Amelia: A Discord bot that is dedicated to a webnovel site called ScribbleHub.
• More to be added, feel free to create an issue if you want to add yours here!

🔮 Version Policy

Velen has a specific version policy, in which, unless there is a critical change to be made, an update will only be released on either of these conditions (this is to prevent me from overworking):

• 3+ issues (bug fixes, feature requests, improvements, etc).
• A critical bug fix.
• A new Javacord update.

The library also follows a similar version number policy with Javacord:

• A change in the first digit of the version will mean: major update or two-three major breaking change.
• A change in the second digit of the version will mean: a large quantity of accumulated updates or a breaking change.
• A change in the last digit of the version will mean: a minor update, usually new features or fixes.