README.md

🧙 DnD Character Generator Plugin

[![Plugin Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](#)  
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)  
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](#)

This is a LoKi plugin that generates a complete **Dungeons & Dragons** character using classic 5e rules and randomization.

---

## 🧪 Slash Command: `/dndcharacter`

### ❓ Description
Generates a full D&D 5e character with randomized:
- **Race**
- **Class**
- **Stats** (rolled using 4d6, drop the lowest)
- **Proficiencies & Expertise**

---

## 🔧 Command Usage

```bash
/dndcharacter name:<character_name>
````

> 🔸 The `name` option is **required**

---

### ✅ Example

```bash
/dndcharacter name:Garrick
```

Returns an embedded message with:

> 🧙 **D\&D Character Generator**
>
> **Name**: Garrick
> **Race**: Tiefling
> **Class**: Sorcerer
>
> **Stats**
> • Strength: 12
> • Dexterity: 14 *(Proficient)*
> • Constitution: 13 *(Expertise)*
> • Intelligence: 10
> • Wisdom: 8
> • Charisma: 17
>
> *Generated randomly using the 4d6 drop lowest method*

---

## 🖼️ Character Avatar (Optional)

You can optionally integrate a fantasy portrait API or service to generate avatars.

> 🧙 [Character Preview Example](https://example.com/character-avatar.png)
> (Integration optional via external API such as DiceBear, Artbreeder, or generated avatars)

---

## 📦 Plugin Metadata

* **Name**: DnD Character Generator
* **Command**: `dndcharacter`
* **Emoji**: 🧙‍♂️
* **Description**: Generates a Dungeons & Dragons character

---

## 🚀 Installation

1. Compile the plugin:

   ```bash
   ./gradlew shadowJar
   ```
2. Move the JAR to your LoKi Bot plugins folder:

   ```
   /loki/plugins/
   ```
3. Restart or reload LoKi to activate it.

---

## 🏷️ Versioning

Current version: **1.0.0**
To tag a release in GitLab or GitHub:

```bash
git tag v1.0.0
git push origin v1.0.0
```

---

## 📜 License

This plugin is licensed under the **MIT License**.

```