Skip to content

Commit aebfd62

Browse files
add initial version of Kiai docs
1 parent a46ed11 commit aebfd62

18 files changed

+357
-2
lines changed

basics.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Kiai Basics
3+
description: Learn the core ideas of Kiai — XP, levels, rewards, and leaderboards.
4+
---
5+
6+
# Kiai Basics
7+
8+
At its core, Kiai is about **turning participation into progress**.
9+
The more you contribute to your server, the more XP you earn, and the higher you climb.
10+
11+
## The Building Blocks
12+
- **XP (Experience Points):** Every message, every voice chat, every bit of activity adds up.
13+
- **Levels:** As XP accumulates, you “level up” — showing your growth to the community.
14+
- **Rewards:** Server admins can set up role rewards or perks tied to certain levels.
15+
- **Leaderboards:** Friendly competition — see who’s the most active in your server.
16+
17+
## Why It Works
18+
Kiai makes everyday activity meaningful. Instead of chatting or hanging out aimlessly, members feel recognized for their contributions.

commands.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Basic Commands
3+
description: Your first steps with Kiai — the essential commands you’ll use most often.
4+
---
5+
6+
# Basic Commands
7+
8+
Once Kiai is in your server, you can start interacting with it right away.
9+
Here are the **core commands** every user should know:
10+
11+
- **`/rank`** → See your current level and XP progress (and how much XP until the next level).
12+
- **`/leaderboard`** → View the top members in your server and how they rank.
13+
- **`/preferences`** → Open your personal settings for Kiai: adjust notification preferences, and control other personal display or privacy options. This is where users manage how Kiai interacts with them.
14+
15+
Start with `/rank` to see where you’re at, then use `/preferences` to tailor the experience to your liking.

content/advanced-xp.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Advanced XP Settings
3+
description:
4+
---
5+
6+
# XP Streaks
7+
8+
XP Streaks allow a user to gain extra XP for gaining a set amount of XP per day.
9+
10+
XP Streaks can be enabled in `/settings > XP Streaks` and set to send in a specific channel. Advanced configuration of XP Streaks is only avaliable to premium guilds. For more information view Premium
11+
12+
# XP Drops
13+
14+
XP Drop settings can be found in `/settings > XP Drops`
15+
16+
XP Drops allow for occasional drops of XP. These time between these drops is determined by the "Minimum Time Between Drops" setting, and can be triggered by the /drop command.
17+
18+
The drop will expire after the configured Expire Time and are limited to the Drops per Day setting. The XP amount is randomized between the Minimum and Maximum XP Amount.
19+
20+
The message sent can be configured as well as what happens when the drop is claimed.
21+
22+
# XP Decay
23+
24+
XP Decay is used to take away xp regularly. It can be used to ensure people are active to keep their levels.
25+
26+
When XP decay runs, the specified amount of XP set in the "XP Decay Amount" setting (located in the "XP Decay" category) will be deducted from everyone.
27+
28+
The XP Interval determines how often XP decay runs.

content/customizing-xp.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Customizing XP Gain
3+
description:
4+
---
5+
6+
# Message XP
7+
Message XP follow a simple set of settings found in `/settings > Message XP`. Message XP is randomly given reguardless of message length.
8+
9+
XP Cooldown specifies how long until another message can count for XP.
10+
11+
Minimum XP per message specifies the minimum amount of xp that can be gained from a message
12+
13+
Maximum XP per message specifies the maximum amount of xp that can be gained from a message
14+
15+
Level Cap specifies the max level that can be achieved. The users will continue to recieve xp, but they will not display as anything above this level.
16+
17+
The Reset Member XP on Leave/Kick option resets a users xp when they leave the guild.
18+
19+
Reset Member XP on Ban resets the xp a user has when they get banned from the server
20+
21+
# XP Formula
22+
23+
The XP Formula specifies how levels will be determined. By default, Kiai uses the formula `12 * ({level} * {level}) + {level} * 12`, which can be visualized here https://www.desmos.com/calculator/jpwyjlqih9.
24+
25+
When making a custom XP Formula, it is important to include {level}, which is replaced with the member's current level and is used to calculate the xp cost to reach the next level.
26+
27+
Kiai does not support restarting XP at 0 each level, but adding `+ {xp}` to your formula will achieve the same result.

content/exclusions.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Exclusions
3+
description: A introduction the the ex
4+
---
5+
6+
# Exclusions
7+
8+
Exclusion settings can be found in `/settings > Denylist`.
9+
10+
Exclusions in Kiai apply to all methods of recieving XP (message, voice, drops, etc). Kiai has 3 exclusion options: Channels, Roles, and Users.
11+
12+
# Channels
13+
14+
Channel exclusions are often set on channels that may be spammed or flooded often or just a channel that is not intended for XP.
15+
16+
# Roles
17+
18+
Roles exclusions can be used to remove the ability for a certain group of users from recieving XP.
19+
20+
# Users
21+
22+
User exclusions are useful on case-by-case basises where someone is abusing the XP system or doing something else that is disruptive.
23+
24+
Exclusions could also be used to prevent top ranking leaderboard users and to encourage a more competitive leaderboard environment.

content/index.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
---
2-
title: Kiai
2+
title: Welcome
3+
description: Introduction to Kiai Docs — start here to learn what Kiai is and how to use it.
34
---
45

5-
[Check out our docs at https://docs.kiai.app](https://docs.kiai.app)
6+
# Welcome to Kiai Docs
7+
8+
Thanks for checking out **Kiai**, the Discord leveling bot by Buape Studios.
9+
This guide is here to help you understand what Kiai is, why servers use it, and how you can get the most out of it.
10+
11+
If you’re new, here’s what you’ll find in these docs:
12+
- [What’s New](./whats-new) → quick overview of the latest improvements
13+
- [Kiai Basics](./basics) → the building blocks of how Kiai works
14+
- [What is Kiai?](./what-is-kiai) → a friendly introduction
15+
- [What is a Leveling System?](./leveling-system) → context for new Discord users
16+
- [Basic Commands](./commands) → your first steps in using the bot

content/intro-to-rewards.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Intro to Rewards
3+
description: Learn what Rewards are and how to use them.
4+
---
5+
6+
# Rewards
7+
8+
Kiai offers rewards as a way to give a user something at a certain level.
9+
10+
Currently there are five reward options:
11+
- Roles
12+
- Custom Messages
13+
- Money (Unbelivaboat Currency)
14+
- Nickname
15+
- Leaderboard Roles
16+
17+
# Roles
18+
19+
<Callout title="Required Permissions" type="info">This type of reward requires the bot to have the `Manage Roles` permission</Callout>
20+
21+
Role rewards can be used to either give or remove a role upon reaching a specified level. Giving roles could be used for level roles such as Level 10, Level 20, etc. Where at a certain level, you want your guild members to gain a role.
22+
23+
The removal action is a similar feature which allows a role to be removed from a user after reaching a level. The main use for this feature of role rewards is to remove a role (usually one that removes certain permissions), which users get on join.
24+
25+
There are optional parameters to both of these to set a required role, where the user will need a role in order to recieve the reward, and a temporary length option that will give the user the reward for a limited amount of time.
26+
27+
# Custom Messages
28+
29+
Custom Messages are used to send a messsage seperate to the level up message. When a user reaches the reward level, Kiai will send the message in the same channel that xp was recieved in. The channel the message is sent in can be configured through the "channel" option in `/rewards add message` and a required role can also be set for this reward.
30+
31+
# Money
32+
33+
Kiai can be integrated with UnbelievaBoat to reward money for reaching a specified level. Similar to the other rewards, a required role can be set for this type of reward. For more information, see UnbelievaBoat Integration.
34+
35+
# Nicknames
36+
37+
Nicknames can be used to give a special nickname at a certain level. For example, if you wanted to put a emoji in someones name when they reach a certain level. This should only be used on one-off cases, if it should apply to all levels, use Nickname Format.

content/unbelivaboat.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: UnbelivaBoat Integration
3+
description: Learn about our Integration with Unbelivaboat
4+
---
5+
6+
# UnbelivaBoat Integration
7+
8+
<!-- TODO: Might be broke -->

content/voice-xp.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Voice XP
3+
description:
4+
---
5+
6+
# Voice XP
7+
8+
<Callout type="info" title="Required Permissions">Kiai must have `View Channel` and `Connect` permissions to the voice channel for this feature to work</Callout>
9+
10+
Voice XP settings can be found in `/settings > Voice XP`
11+
12+
Kiai offers Voice XP, a feature that allows members to get XP by being in a voice channel.
13+
14+
To gain XP, the voice channel must have more than the configured minimum users required to gain XP and will only recieve XP for the time they spent unmuted in the voice channel. XP is awarded when the user leaves the voice channel.

content/welcome.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Welcome
3+
description: Introduction to Kiai, a profound and versatile levelling bot that allows communities to enhance their member experience.
4+
---
5+
6+
![Kiai Logo](https://cdn.buape.com/Kiai.png)
7+
8+
Kiai is a advanced leveling bot for Discord.

0 commit comments

Comments
 (0)