Skip to content

Installing From Source

Kotz edited this page Mar 19, 2022 · 5 revisions

If you are not an advanced user and don't want to compile Akko yourself, head over to the regular Installation Guide.

Prerequisites

  • The latest .NET SDK
  • PostgreSQL
  • Git
  • A text editor of your choice
  • A Discord bot account
  • Intermediate computer knowledge (how to troubleshoot problems you may encounter, not being afraid of using the terminal, be able to read and follow instructions)

Setup

  • If you still don't have a bot account set up on Discord, follow the Discord Setup section of the regular guide, then return here.
  • Install the latest .NET SDK.
  • Install Git.
  • Install PostgreSQL.

Installation

  • Clone the repository by running the following command on your terminal:
    • git clone https://github.com/Akko-Bot/AkkoBot.git
  • Navigate to the primary project:
    • cd AkkoBot/AkkoBot
  • Use dotnet publish -c Release to compile Akko. There are several compilation flags you can use to customize the build to your needs.
    • Tip: setting the --self-contained flag bundles the runtime with the bot, allowing it to be executed on a system that does not have .NET installed.
    • Example: The following command compiles Akko for 64-bit Linux systems with the runtime and merges all files into a single one:
      • dotnet publish -c Release -r linux-x64 -p:PublishSingleFile=true --self-contained
  • Execute the bot.
    • dotnet AkkoBot if compilation was not self-contained.
    • Execute the file directly if compilation was self-contained.
  • Once the bot is running, go through the credentials setup and you should be done.

Clone this wiki locally