Clan Commander

Discord bot to manage clans from the game Clash Of Clans.

Key Features • Upcoming Features • How To Use

Key Features

• Discord Server Mangement
  • Change prefix that triggers commands
• Discord Server Clans
  • Add & remove clans from your server
  • Add users to your clan roster
• Link Clash Of Clans account to User
• Cross platform hosting with the .NET runtime

Upcoming Features

• Moderation commands/tools
• User welcome system
• Discord channel event logging
• Clash Of Clans account & clan verification
  • Block other users/servers linking clans & accounts unless they have api key
• Clan Entry/Recruitment System
  • Custom entry requirement strategies
  • Auto role & account linking management
  • Custom messages / instructions
• In-game event notifications
• Clan war management
• Clan War Leagues management

How To Use

To download this application, I recommend cloning it via Git, which you'll need installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/jacobkford/ClanCommander

You will need two different API tokens to run this application, which are the following:

• Discord Bot Token
• Clash Of Clans API Token

There are two ways you can run this application, either using Docker (quicker) or manually installing all the dependancies and running it via the .NET runtime.

Docker

Go into the ClanCommander project folder you've just downloaded, and open the docker-compose.yml file, and update the environment credentials highlighed below:

# clancommander.discordbot service
environment:
  - Discord__BotToken= # add bot token here
  - Discord__BotOwnerId= # add your discord user id
  - Discord__DevGuildId= # add dev/test guild id
  - ConnectionStrings__PostgreSQL= # add db connection string here
  - ConnectionStrings__Redis= # add redis connection string here
  - ClashOfClansAPI__Token= # add Clash Of Clans api token here

After you've setup all the environment credentials, you will need to open your command line and do the following:

# Go into the ClanCommander repository
$ cd ClanCommander

# Run the application
$ docker-compose run

.NET Runtime

To run this application without docker on your machine, you will need to download & install the following:

• .NET 6 SDK
• PostgreSQL
• Redis

You will also need two different API tokens to run this application, which are the following:

• Discord Bot Token
• Clash Of Clans API Token

After you've installed & obtained all the recruitments, we will now need to update the following enviroment credentials in our appsettings.json file:

{
  "Discord": {
    "BotToken": "", # add bot token here
    "BotOwnerId": 0, # add your discord user id
    "DevGuildId": 0 # add dev/test guild id
  },
  "ConnectionStrings": {
    "PostgreSQL": "", # add db connection string here
    "Redis": "" # add redis connection string here
  },
  "ClashOfClansAPI": {
    "Token":  "" # add Clash Of Clans api token here
  }
}

After you've setup all the environment credentials, you will need to open your command line and do the following:

# Go into the ClanCommander repository
$ cd ClanCommander

# Build application
$ dotnet build .\src\ClanCommander.DiscordBot\

# Run application
$ dotnet run .\src\ClanCommander.DiscordBot\