README.md

CVNBot

Quick start

Clone the repo, git clone git://github.com/countervandalism/CVNBot.git, or download the latest release.

Versioning

We use the Semantic Versioning guidelines as much as possible.

Releases will be numbered in the following format:

<major>.<minor>.<patch>

The -alpha suffix is used to indicate unreleased versions in development.

For more information on SemVer, please visit https://semver.org/.

Build

The software is written in C# and originally created as a Visual Studio Project. We use mono to run the executable and msbuild to build the executable.

Recommended installation methods:

• For Linux, install mono-complete from Debian, or latest from mono-project.com,
• For Mac, install Visual Studio for Mac (enable Mono and .NET during installation).
• For Windows, install Visual Studio (enable Mono and .NET during installation).

For standalone command-line installations on Mac or Windows, see monodevelop.com.

Currently supported versions of Mono: 6.8

Once mono is installed, build the project. The below uses Debug, for local development. (See Installation for how to install it in production):

countervandalism/CVNBot:$ msbuild src/CVNBot.sln /p:Configuration=Debug

Once built, you can run it:

countervandalism/CVNBot/src/CVNBot/bin/Debug:$ mono CVNBot.exe

Bug tracker

Found a bug? Please report it using our issue tracker!

Documentation, support and contact

• Documentation (wiki)
• #countervandalism on Libera.Chat
• [email protected] (Requires subscription before posting. Subscribe here)

Copyright and license

See LICENSE.