<commit_before># Kormir - Discord Bot
A Discord bot that's powering the (mainly Guild Wars 2) guild Legacy of the Six.
While this bot is technically designed for their Discord server, you can adapt it for your own use as well.

## Features
The bot can do various tasks that helps the guild on the Discord server.
 - **Guild Wars 2**
   - Accounts
     - Link Discord accounts with Guild Wars 2 accounts by registering API keys
     - Automatically manage roles of world members
   - Guilds
     - Automatically manage roles of guild members
     - Post various guild logs
   - Other
     - Post new builds and release notes
     - Querying the Guild Wars 2 wiki for something
 - **Event scheduling**
   - Add, edit and remove events with a title, description, associated channels and people/roles
   - Automatically post reminders about an event
 - **Other**
   - Exporting the list of role, channel and account ids to help configuring the bot *(restricted by permissions by default)*

### Available commands
You can type `!help` in any text channel to receive the list of available commands.
This message will get removed automatically after 5 minutes to prevent cluttering.
You can also type `!help <command>` - where `<command>` is the name of an available command - in order to receive more detailed information about a specific command.

## Usage
This bot is currently not publically available for invites. Instead, you have to run the bot for yourself.
There are two options: use Docker or set it up manually.
Do note that at this moment, this bot is not made to be ran on more than one Discord server simultaneously, and therefore hasn't been tested for that.
After installation, don't forget to edit the settings in the *config* folder (check *config/default.yml* for instructions).
The bot requires a reboot after every configuration change.

### Docker
 - Have [Docker](https://docs.docker.com/engine/installation/) and [Docker Compose](https://github.com/docker/compose/releases) installed
 - Clone or download the zip of a specific version (or master if that isn't available)
 - Run:
   
   ```bash<commit_msg>Update README with the latest features [ci skip]<commit_after># Kormir - Discord Bot
A Discord bot that's powering the (mainly Guild Wars 2) guild Legacy of the Six.
While this bot is technically designed for their Discord server, you can adapt it for your own use as well.

## Features
The bot can do various tasks that helps the guild on the Discord server.
 - **Guild Wars 2**
   - Discord Synchronization
     - Link Discord and Guild Wars 2 accounts with API keys
     - Automatically manage roles of world and/or guild members
   - Accounts
     - Home instance cats progression
   - Guilds
     - Post various guild logs automatically
   - Other
     - Post new builds and release notes automatically
     - Query the Guild Wars 2 wiki for something
     - Post random quaggans
 - **Event scheduling**
   - Add, edit and remove events with a title, description, associated channels and people/roles
   - Automatically post reminders about an event
 - **Management**
   - Exporting the list of role, channel and account ids to help configuring the bot (restricted by permissions by default)
 - **Utilities**
   - Rolling dice

### Available commands
You can type `!help` in any text channel to receive the list of available commands.
This message will get removed automatically after 5 minutes to prevent cluttering.
You can also type `!help <command>` - where `<command>` is the name of an available command - in order to receive more detailed information about a specific command.

## Usage
This bot is currently not publically available for invites. Instead, you have to run the bot for yourself.
There are two options: use Docker or set it up manually.
Do note that at this moment, this bot is not made to be ran on more than one Discord server simultaneously, and therefore hasn't been tested for that.
After installation, don't forget to edit the settings in the *config* folder (check *config/default.yml* for instructions).
The bot requires a reboot after every configuration change.

### Docker
 - Have [Docker](https://docs.docker.com/engine/installation/) and [Docker Compose](https://github.com/docker/compose/releases) installed
 - Clone or download the zip of a specific version (or master if that isn't available)
 - Run:
   
   ```bash
{'fraction_non_alphanumeric': 0.06097282484585522, 'fraction_numerical': 0.0022836263987211693, 'mean_word_length': 3.7453954496208017, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6086168', 'n_tokens_mistral': 1131, 'n_tokens_neox': 1054, 'n_words': 624}