# English

## Note

The bot operates on slash commands. In order to see the list of commands, type `/`. As long as you have necessary permissions, you will be able to see bot commands.

## Overview

Clans (guilds) are basically groups of users. Each clan can be customized - more about that in the next section.

Clans can gain 3 different types of points:
- XP - by sending messages
- Voice score - by being active in voice channels
- Reputation - from games or from some sort of server-specific activities

If necessary, XP and reputation can be assigned by admins manually with `/xp` and `/reputation`. Use these commands wisely.

One can globally set any score to 0 using `/reset`.

## Creating and customizing clans

Creating a clan is as simple as using `/create-guild` and entering a name. Now to the fun part.

`/edit-guild` allows to change various things in your clan:
- `/edit-guild set` allows to change parameters like member limit, color, etc.
- `/edit-guild add` allows to add a guild role, a helper or a forcing-role
- `/edit-guild remove` allows to remove a role, a helper or a forcing-role
- `/edit-guild description` - edit guild description
- `/edit-guild ownership` - transfer ownership


### What are forcing-roles?

Let's say we have a guild named "Legion" with a forcing-role `@Legioner`. Once `@Legioner` is assigned to a user, this user automatically becomes a member of "Legion". This doesn't affect users that are already in a clan (any clan).

## Interacting with clans

Here're the main commands to interact with clans:
- `/top` - view the leaderboard of clans
- `/join` - join a clan
- `/leave` - leave a clan
- `/guild-info` - detailed info about a clan
- `/user-info` - user's progress in their clan
- `/guild-top` - view the leaderboard of one clan
- `/global-top` - view the leaderboard of all members from all clans
- `/invite` - generate an invite to your clan

Clan owners and helpers can `/kick` or `/ban` members. If their clan is private, they can also `/accept` or `/decline` join requests.

## Permission settings

You might want to change required permissions for slash commands. In order to do that, follow these simple steps:
- Go to **Server Settings**
- Go to **Integrations** tab
- Choose **Guild Manager** from the list of integrations

Now you can configure channels for slash commands, choose which roles can use certain commands, etc.

For instance, this is how you configure so called creator-roles.

### Note

Some commands like `/edit-guild`, `/delete-guild`, `/kick` or `/ban` should be accessible to guild owners, which might not have necessary roles. In order to allow these commands to someone else (e.g. moderators) without blocking it for server owners, configure master-roles: `/master-roles`.

## Bot settings

The bot has various parameters to suit different servers.

- `/settings` - view current settings
- `/lang` - change the language
- `/ignored-channels` - configure channels where XP won't be added
- `/set-guild-limit` - set the maximum allowed number of guilds on your server
- `/set-member-limit` - set the maximum allowed number of members for all guilds (guild settings can override this)
- `/set-creator-limit` - set the maximum amount of guilds a user can create
- `/temporal-creator-roles` - configure which roles should be removed from anyone who creates a guild
- `/lock-guild-exits` - prevent users from leaving their guilds
- `/set-auto-actions` - ask the bot to create extra things for new guilds (e.g. role, text channel, voice channel, category)
- `/keep-ghosts` - whether the bot should keep guild members that left the server in their guilds (they will be displayed as plain IDs 18-22 digits long)
- `/xp-lock` - prevent users from getting XP unless switched back
- `/toggle-games` - enable or disable games on your server (more about games in the next section)
- `/toggle-game-rewards` - enable or disable reputation rewards in games

## Games

Games can be enabled with `/toggle-games`.

Currently there're 3 games: tic-tac-toe (`/tic-tac-toe`), ultimate-tic-tac-toe (`/uttt`), and sea battle (`/sea-battle`).

Any 2 users can play against each other. If both of them are in a clan, the winner gains reputation for their clan, while their opponent decreases their clan's reputation. If both individuals happen to be from the same clan, nothing happens - the battle is considered friendly.

You can make all games casual using `/toggle-game-rewards`.

## How XP is added

By default each member receives 10 XP per 30 seconds of chat activity.

There's a mechanic that slightly boosts XP of small guilds. This is roughly how it works:
- A guild with less XP gets slight XP boost
- A guild with less members gets slight XP boost

Here's an exact formula: `clan_income = round(10 - 20 * log(2) + 10 * log(k1 + 1) + 10 * log(k2 + 1))`, where
- `k1 = max(1, (top_clan.member_count + 1) / (clan.member_count + 1))`
- `k2 = (top_clan.xp + 100) / (clan.xp + 100)`



# Русский

## Примечание

Бот работает на слеш командах. Чтобы увидеть список команд, наберите `/` (не отправляя). Всплывёт список доступных команд. Если этого не происходит, проверьте свои права и права бота.

## Общие сведения

Кланы (гильдии) по сути являются группами пользователей. Каждый клан может быть кастомизирован - это подробнее описано в следующей секции.

Кланы могут получать 3 типа очков:
- Опыт - очки за отправку сообщений
- Голосовая активность - за время, проведённое в голосовых каналах
- Репутация - за победы в играх или за какое-нибудь серверное мероприятие

При необходимости администраторы могут вручную начислить опыт и репутацию командами `/xp` и `/reputation` соответственно. Используйте их с умом.

Можно обнулить любой тип очков командой `/reset`.

## Создание и настройка кланов

Создать клан можно просто использовав `/create-guild`. Теперь к главному.

Команда `/edit-guild` позволяет поменять множество параметров:
- `/edit-guild set` меняет параметры типа лимита участников, аватарки или цвета гильдии
- `/edit-guild add` - можно добавить роль гильдии, помощника или форсирующую роль
- `/edit-guild remove` - можно удалить роль гильдии, помощника или форсирующую роль
- `/edit-guild description` - поменять описание гильдии
- `/edit-guild ownership` - передать права владельца


### Что такое форсирующая роль?

Пусть имеется гильдия "Легион" с форсирующей ролью `@Легионер`. Как только пользователь получит роль `@Легионер`, бот автоматически добавит его в клан "Легион". Однако, это не касается пользователей, которые уже находятся в каком-либо клане.

## Взаимодействие с кланами

Вот список основных команд для взаимодействия с кланами:
- `/top` - посмотреть топ кланов
- `/join` - вступить в клан
- `/leave` - покинуть клан
- `/guild-info` - информация о клане
- `/user-info` - прогресс пользователя в его клане
- `/guild-top` - посмотреть топ участников какого-то клана
- `/global-top` - посмотреть топ всех участников всех кланов
- `/invite` - сформировать приглашение в клан

Владельцы и помощники кланов могут исключать или банить участников при помощи `/kick` и `/ban`. Если клан приватный, то можно рассматривать заявки: `/accept`, `/decline`.

## Настройки прав

Вам, скорее всего, понадобится поменять разрешения для разных слеш команд. Чтобы сделать это, вы полните эти 3 шага:

- Перейдите в **Настройки сервера**
- Перейдите во вкладку **Интеграции**
- Выберите интеграцию **Guild Manager** из списка

Теперь Вы можете настроить каналы для команд, разрешить или запретить определённым ролям использовать ту или иную команду, и т.д.

Например, таким образом можно настроить роли создателей гильдий.

### Примечание

Такие команды, как `/edit-guild`, `/delete-guild`, `/kick` или `/ban` должны быть доступны владельцам гильдий независимо от того, есть ли у них какие-либо роли. Поэтому, если Вам нужно разрешить эти команды, например, модераторам, но не запретить владельцам гильдий, настройте мастер-роли: `/master-roles`.

## Настройки бота

В боте есть много настраиваемых параметров. Вот список нужных для настройки команд:

- `/settings` - посмотреть текущие настройки
- `/lang` - поменять язык
- `/ignored-channels` - настроить каналы, в которых не должен начисляться опыт
- `/set-guild-limit` - поменять лимит гильдий на сервере
- `/set-member-limit` - поменять лимит участников в гильдиях (настройки гильдии берут приоритет)
- `/set-creator-limit` - поменять максимум создаваемых одним пользователем гильдий
- `/temporal-creator-roles` - какие роли должны убираться с пользователя во время создания им гильдии
- `/lock-guild-exits` - запретить участникам выходить из гильдий
- `/set-auto-actions` - создавать ли роли и каналы для новых гильдий
- `/keep-ghosts` - оставлять ли в гильдиях пользователей, вышедших с сервера
- `/xp-lock` - приостановить получение опыта за сообщения
- `/toggle-games` - включить или выключить игры (подробнее в следующей секции)
- `/toggle-game-rewards` - включить или выключить репутацию за игры

## Игры

Игры можно включить командой `/toggle-games`.

В данный момент бот поддерживает три игры: крестики-нолики (`/tic-tac-toe`), сложные крестики-нолики (`/uttt`) и морской бой (`/sea-battle`).

Любые два пользователя могут сыграть друг против друга. Если они при этом являются участниками разных кланов, то победитель увеличит репутацию своего клана, а проигравший - уменьшит. Если же кто-то из игроков не был в клане, или оба игрока состоят в одном и том же клане, то с репутацией ничего не произойдёт.

Во всех играх можно отключить победную репутацию командой `/toggle-game-rewards`.

## Как начисляется опыт

По умолчанию участник получает 10 опыта каждые 30 секунд, если в этот период он отправлял сообщения на сервере.

Есть механика буста опыта отстающих гильдий (как по опыту, так и по участникам). Работает она примерно так:
- Чем меньше у гильдии опыта (по сравнению с лидером), тем больше опыта она получает (но не сильно больше)
- Чем меньше у гильдии участников, тем больше опыта она получает

Вот более точная формула: `clan_income = round(10 - 20 * log(2) + 10 * log(k1 + 1) + 10 * log(k2 + 1))`, где
- `k1 = max(1, (top_clan.member_count + 1) / (clan.member_count + 1))`
- `k2 = (top_clan.xp + 100) / (clan.xp + 100)`


Guild Manager

Begin an epic Clan War on your Discord server!
Clan bot | Customizable | Message based XP | Statistics | Voice activity

Voting for Guild Manager

Do you want to support us?