# Welcome to Habrok Documentation

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FD77Cbmvt9LZOckI774GJ%2Fhabrok_dev_rounded.png?alt=media&amp;token=b0b10920-8dc4-4d81-a153-31ec3d85edd4" alt="" width="256"><figcaption></figcaption></figure>

## About

Habrok (named after [Hábrók](https://en.wikipedia.org/wiki/H%C3%A1br%C3%B3k)) is a Discord bot useful for staff members to identify how appreciated or toxic someone is in your community.

## Quick links

{% content-ref url="/pages/EJRUvyiGKhkQYFxnXoiv" %}
[Adding the bot](/overview/adding-the-bot)
{% endcontent-ref %}

{% content-ref url="/pages/Z4I728xok5AXmM5FuYFf" %}
[Support Server](/overview/support-server)
{% endcontent-ref %}


# Adding the bot

## Adding the bot in your server

[Click here](https://invite.habrok.app) to add the bot in your server&#x20;

## Permissions

* "Manage Roles": This is required to assign roles to your guild members
* "View Audit Log": This is currently used for checking who invited the bot, and will later be used for automation and advanced reputation calculation
* "Read Messages": This allows the bot to see the channels to later allow for a logging channel. The bot **cannot** read messages.
* "Send Messages": This allows the bot to answer to commands.
* "Use Application Commands": This allows the bot to register commands (both slash and context menu)


# Support Server

## Support server link

You can join the support server by [clicking here](https://support.habrok.app).

Don't forget to select "Habrok" in the onboarding modal:

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2Ft0DmZYYGQkM5WbFvrZd7%2Fimage.png?alt=media&amp;token=0fca2b5a-dae5-4f2d-bd5c-a09ae5625d19" alt=""><figcaption></figcaption></figure>


# Warnings

{% hint style="danger" %}
Be careful when you set the rewards. Some communities are more prone to alt accounts, so don't give out important permissions.
{% endhint %}

{% hint style="warning" %}
When setting the rewards, make sure the bot's role is **above** the rewarded roles in the server's role list. Otherwise the bot will not be able to give them out.
{% endhint %}

{% hint style="info" %}
When you set or update rewards, the changes are not directly applied to your server's members. However, when a member uses the `/check-reputation` command, they are recalculated.
{% endhint %}


# Configuring the bot

/config command

## Permission

This command is available to Administrators only.

## Purpose

This commands allows you to check the current server configuration, checking the sharing setting and the role rewards.

### Sharing reputation

Reputation is shared by default. It allows staff to see the user's reputation in other servers.

You can disable it by clicking the "Change sharing setting" button, which will isolate your server.

### Rewards

Those are the rewards set for your server, more details in [Setting a reward](/admin-features/setting-a-reward)

## Example

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FMWMoVYwwC03oLxbTDOuM%2Fimage.png?alt=media&amp;token=71826ad2-3266-44ed-981a-33fb1482c30e" alt=""><figcaption></figcaption></figure>


# Setting a reward

/set-reward command

## Permission

This command is available to Administrators only.

## Purpose

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FW6niA01rkoaiELSIRNqQ%2Fimage.png?alt=media&amp;token=b3a462eb-e596-493b-8ca7-6d257c7a82d0" alt=""><figcaption></figcaption></figure>

This commands allows you to set a reward to users whose reputation exceed a certain score.

## Arguments

### role

This is the role that will be set to the community member.

### score-needed

The score that the user needs to earn the role.

{% hint style="danger" %}
To avoid abuse, you cannot set a reward to a negative score. The bot is not intented to be used as an automoderator.
{% endhint %}

### score-before-rescind

This is the score under which the role will be removed. This is used as a buffer to avoid a role being added to and removed from a member too quickly.

{% hint style="warning" %}
The "score-before-rescind" must be lower than or equal to "score-needed".
{% endhint %}

{% hint style="info" %}
Since a role can only be rewarded once, you can edit a reward by running the command a second time with the same role.
{% endhint %}

## Example

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FFf8mCkZLtKhUPrY0Sth2%2Fimage.png?alt=media&amp;token=f8dbff06-895f-4791-90bd-f7dca980658b" alt=""><figcaption></figcaption></figure>


# removing a reward

/remove-reward command

## Permission

This command is available to Administrators only.

## Purpose

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2F0OdF3m0DKSiAzZY5ElxR%2Fimage.png?alt=media&amp;token=aa7942a2-c252-4943-ae6e-93913bf6770c" alt=""><figcaption></figcaption></figure>

This commands allows you to remove a reward.

## Arguments

### role

This is the role currently given as the reward you wish to remove.

{% hint style="warning" %}
This command will neither delete the role nor remove it from your server members.
{% endhint %}

## Example

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FWq87UUtjQ6eqfoG4DNR1%2Fimage.png?alt=media&amp;token=0c4e242a-605a-4f4b-b59a-13d16534c91f" alt=""><figcaption></figcaption></figure>


# Giving to or removing a reward from a member

/override-reward command

## Permission

This command is available to members with the permission "Manage Messages".

## Purpose

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2F0nL9LUJO2lYeRZmXGZGZ%2Fimage.png?alt=media&amp;token=0ce72486-38f4-49de-b986-56924437ba7a" alt=""><figcaption></figcaption></figure>

This commands allows you to manually give a reward to a server member, or to deny it so they never have access to the reward.

## Arguments

### role

The role associated to the reward you wish to give to the user

### action

This is either `GIVE` `DENY` or `RESET`.

* `GIVE`: manually gives the reward
* `DENY`: prevents the member to ever getting the reward (and removes it if the user already has it)
* `RESET`: removed the manual override, the reward reset is recalculated using the reputation score only

## Example

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FBApgF15fij0CcndgnIoY%2Fimage.png?alt=media&amp;token=ee7ffdb1-c2b5-4424-987e-fe495008cd1b" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FVU90Hdhch1ALksKRtZ9M%2Fimage.png?alt=media&amp;token=967f9952-65e1-4c77-8d34-8b46806190b6" alt=""><figcaption></figcaption></figure>


# Checking a member's reputation

/check-member-reputation command and check-reputation context menu

## Permission

This command is available to members with the permission "Manage Messages".

## Purpose

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FTnmpORa7OJ74TxTSfUqP%2Fimage.png?alt=media&amp;token=496f1e2f-0091-4b77-b852-85d710091c8d" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FaSdBtAuF9RBF3JaOT0im%2Fimage.png?alt=media&amp;token=52fa72fb-8a15-4399-b862-9057218ba1fd" alt="" width="443"><figcaption></figcaption></figure>

This commands allows you to check a member's reputation score.

{% hint style="info" %}
The detailed view shows "++" or "--" when the person who rated the community member is a staff member
{% endhint %}

## Arguments

### user

The member whose reputation score you wish to check.

## Example

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2F9eitYUOSxT5jAerYpFCR%2Fmember_stats.png?alt=media&amp;token=aacc11a5-ff2e-45ef-9bf6-7b87073d7190" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FQcYyDwltXoeTQW4WuIm2%2Fmember_stats_detailed.png?alt=media&amp;token=f9ee4f1a-a165-4086-b4fd-713c0b0c50ba" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FybrbKwvNfvhMH8mmQeYR%2Fmember_stats_shared.png?alt=media&amp;token=77ad0a21-ec99-467d-85dc-b22d97200c3b" alt=""><figcaption></figcaption></figure>


# Checking your reputation score

## Permission

This command is available to everyone, although staff members (with the "Manage Messages" permission) will have more details.

## Purpose

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FQ4UL074KiapjgmsTOXdX%2Fimage.png?alt=media&amp;token=b9b69afb-f8f8-410a-96c4-a1259c9cbde3" alt=""><figcaption></figcaption></figure>

This commands allows you to check your current reputation score.

## Example

<figure><img src="https://1094611688-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFQZptSheoFNdJZHsSnbs%2Fuploads%2FH6xpr0yBa4BF7Iz4ONuz%2Fimage.png?alt=media&amp;token=dd030189-194e-4bcd-9950-9487e5bc1572" alt=""><figcaption></figcaption></figure>


