install.md

Install CVNBot

Installation

1. Compile the code by running the following command:

   msbuild src/CVNBot.sln /p:Configuration=Release

   This command creates CVNBot.exe and other files in the output directory at src/CVNBot/bin/Release.

2. Create a directory for your bot, and move the contents of src/CVNBot/bin/Release to it.

3. Edit CVNBot.ini: Set at least botnick.

4. Set permissions and ownership correctly. This step is after the copying of files because group ownership is usually not preserved when copying files.

   • For personal use, chmod 644 *, chmod 600 CVNBot.ini, and chmod 755 CVNBot.exe.
   • For Countervandalism Network:chmod 664 *, chmod 660 CVNBot.ini, chmod 755 CVNBot.exe, and chgrp cvn.cvnservice *.

5. You can now start the start the bot by running mono CVNBot.exe from your bot directory.
   The bot will join the specified feedchannel (by default: #cvn-sandbox).

Upgrade

1. Compile the code by running the following command:

   msbuild src/CVNBot.sln /p:Configuration=Release

   This command creates CVNBot.exe and other files in the output directory at src/CVNBot/bin/Release.

2. Enter src/CVNBot/bin/Release.

3. Remove Projects.xml and CVNBot.ini (to avoid accidentally overwriting your existing ones, later)

4. Make sure the bot is not currently running (e.g. Botname quit on IRC, and check output of ps aux).

5. Copy all remaining files in src/CVNBot/bin/Release to your existing bot directory. For example: src/CVNBot/bin/Release$ cp * /srv/cvn/services/cvnbot/CVNBotXYZ/

6. Set permissions and ownership correctly. This step is after the copying of files because group ownership is usually not preserved when copying files.

   • For personal use, chmod 644 *, chmod 600 CVNBot.ini, and chmod 755 CVNBot.exe.
   • For Countervandalism Network:chmod 664 *, chmod 660 CVNBot.ini, chmod 755 CVNBot.exe, and chgrp cvn.cvnservice *.

7. Start the bot (or, let stillalive start it).