# Koira's Docs

### Welcome to the Documentation

Welcome to the official documentation for Koira, the Discord Bot with a complete logging module! Below you'll find a set of useful marks and indicators which you'll see throughout our documentation.

If you have any other inquiries don't hesitate to contact us in [our Support Server](https://discord.gg/6YCUFCapjj)

### About the Documentation

{% hint style="success" %}
A **success** hint will indicate **useful tips** you should consider while using the bot.
{% endhint %}

{% hint style="info" %}
An **information** hint will indicate **additional data or notes** about the topic being addressed.
{% endhint %}

{% hint style="warning" %}
A **warning** hint will indicate **things to prevent** while using the bot.
{% endhint %}

{% hint style="danger" %}
A **danger** hint will indicate a **known bug or removed features**.
{% endhint %}


# Setup Guide

Hello and welcome to Koira! The last logging bot your Discord server will ever need. Depending on how granular you want your setup there are a couple different ways you can set up Koira to suit your needs. Please note you will need to have the `MANAGE_SERVER` permission in your guild to run any command in this section.

### Basic Setup

By using the `/setup` command you can use our predefined bundles to make your experience setting up Koira quick and efficient so you can get back to running your server. We currently have 4 bundles available to choose from, which you can read more about [here](/setupguide) or in the setup command itself. You can select one or more bundles to edit at a time.

![Koira Setup Command Part 1](https://i.imgur.com/hP2Bu88.png)

#### Choosing your channel type

In this section Koira will ask you what type of channel you would like your logs to be in, a Forum, a normal Text channel, or a Thread.

{% hint style="info" %}
If you choose the Thread option, a new channel called `#koira-logs` will be created with a thread for each bundle being attached to this channel.
{% endhint %}

![Koira Setup Command Part 2](https://i.imgur.com/RDwPhP9.png)

#### Congratulations

You have now set up Koira in your server! Using the `/setup` command you can add a new bundle or change the settings for a particular bundle at any time .

### Advanced Setup

If you want a more granular approach to your logs, you can choose where to log any one individual event in your server with the `/settings` command. This command can also be used to view the current settings to see where a specific event is set up to be logged to in your server.

{% hint style="success" %}
This is a much more time intensive process and only recommended for experienced server administrators.
{% endhint %}

![Koira Settings Command - Channel](https://i.imgur.com/txAfDIM.png)

You are able to edit an entire section of settings, such as invites or channels, at once with the "Bulk Edit" button.

![Highlighted Bulk Settings button](https://i.imgur.com/RgvfR6D.png)

### Need more help?

Please get in touch with us in our [Support Server](https://discord.gg/6YCUFCapjj) and we will be more than happy to assist you with any issues you may have!


# FAQs

## Table of Contents

| **Number** | **Question**                                                                                   |
| ---------- | ---------------------------------------------------------------------------------------------- |
| `1`        | [How do I put all of my logs into one channel?](#how-do-i-put-all-of-my-logs-into-one-channel) |
| `2`        | [Why is *X* permission needed?](#why-is-x-permission-needed)                                   |

### How do I put all of my logs into one channel?

You can do this by clicking "Bulk Edit" immediately after using the `/settings` command![Bulk Edit of server Settings](https://i.imgur.com/7fsultX.png)

### Why is *X* permission needed?

#### Manage Webhooks

As of this moment this permission is not needed, but in the future we will move to webhook based logging in order to handle ratelimtis more efficiently, so Koira will require this permission to function in the future.

#### View Audit Log

This is needed to allow Koira to view events such as a channel being created, or a moderator kicking a user.

#### View Channels

View Channels is needed so Koira can view information on channels.

#### Send Messages / Send Messages in Threads

In order to notify you about changes in your server, Koira needs to be able to send messages in your server. If you do not choose to utilize thread style logging the Send Messages in Threads permission can be ommitted.

#### Embed Links and Attach Files

Koira contains the capbility to log changes in your server such as changes to the server icon and emojis being added to your server, without the ability to attach files and embed links, some log messages may appear malformed.

#### Read Message History

This permission is needed to allow Koira to see messages to know when they have been updated.

#### Use External Emojis

In many of our messages we utilize external emojis to enhance your Koira experience, without this permission some messages from Koira may not be displayed correctly.

#### Manage Channels

Koira has the ability to set up log channels for you, and need the ability to create channels in order to do so.


# Commands

As Koira's main purpose is logging, we have relatively few commands implemented. Below is a list of all of the commands Koira has and their functions.

* `/alive` - Returns the bot's response time
* `/debug` - This command is useful for determining if there an issue in regards to the permissions Koira has in your server. It also provies helpful information that the support team may ask for when assisting you.
* `/help` - Allows the user to access the help panel, which lists all commands for the bot with short descriptions of each.
* `/settings` - This command allows server administrators to granularly change settings in regards to where an event should be logged, if at all, among other opions. Please note this command requires you to have the `MANAGE_SERVER` permission to be used.
* `/setup` - Setup allows for a quick setup of the bot using our Bundles system. Please check out our [Setup Guide](/setupguide) for more information on configuring Koira. Please note this command requires you to have the `MANAGE_SERVER` permission to be used.
* `/support` - Provides a link to the support server, should you find yourself in need of assistance.
* `/vote` - Provides links to allow users to vote for the bot on the bot listing services we are on. This command always returns an ephemeral reply.


# Credits

### Development

[Yareaj](http://koira.bot)

### Ideas, Sanity Checks, Code Help, etc.

[Prizafal](https://prizafal.com)

### Beta Testing

* .jstitch
* .tinyy
* 24felix
* 3v.dev
* danielvf\_
* dominikdev
* heyemmay
* infnerno
* lias1948
* polyluria
* prizafal
* R31GNDEV
* satisfy.ai
* skapzz
* turkerssh
* yareaj\_
* zylas