NeKzBot

Current Version: 2.0.0 | Last Update: May 2021

Introduction

NeKzBot is a chat bot for Discord which finds its application in our Portal 2 speedrunning community server.

Features

• Notification System
  • Auditor
  • speedrun.com
• SourceEngine Demo Parser
• Portal 2 Challenge Mode Stats
• SourceEngine Command Lookup
• Code Execution Engine

Versions

Credits

• Baister - for trusting my coding skills and the changes that I brought to the server
• Portal 2 Speedrunning community - for making the bot more robust by breaking and exploiting certain features
• Discord.Net Developers - for introducing me into the world of API libraries and .NET
• Discord - for making the world's best documented API

Dependencies

• Discord.Addons.Interactive
• Discord.Addons.Preconditions
• LiteDB
• Newtonsoft.Json
• Portal2Boards.Net
• SourceDemoParser.Net

Installation

Requires .NET 5.0 or higher.

• git clone --recurse-submodules https://github.com/NeKzor/NeKzBot
• cd NeKzBot
• ./install
• Configure private/credentials.json
  • Discord app bot token
  • speedrun.com API token
• ./build
• ./run

Modules

Non-public modules are marked as * which require to be admin or owner

• Commands are denoted as .command or .command.subcommand
• Command arguments are denoted as <argument>
• Text arguments are denoted as <argument...>
• Optional arguments are denoted as <argument = 10> or <argument = optional>
• Optional text arguments are denoted as <argument... = optional>

Admin

Note: Requires to have special permissions.

.invites

Lists all invites of the server.

.audits <count = 10>

Lists audit logs of the server.

.pin <message_id>

Manually pins a given message. Will ask to create a new pin board for the server if it does not exist.

.pin.set

Configures pin board settings. Asks for the number of pins required, the emoji to use for pinning messages and then the amount of days until a message should be ignored for pinning.

.pin.set.reactions <minimum_reactions>

Configures pin board setting for number of minimum reactions required for pinning messages.

.pin.set.emoji <emoji>

Configures pin board setting for the emoji to use for pinning messages.

.pin.set.days <days_until_message_expires>

Configures pin board setting for the amount of days until a message should be ignored for pinning.

Code

.code.?

Prints information about this module.

.code.run <language> <code...>

Executes code of a give programming language. New code can be run again by editing the previous message.

Example:

.code.run bash
```bash
cat /etc/passwd
```

Fun

.ris <text...>

Converts given text to regional indicator symbols.

Info

.info

Prints information about the bot.

.stats

Prints bot statistics.

.modules

Prints a list of all modules with a link to this documentation.

Owner

Note: Requires to be bot owner.

.tasks

Used when automated tasks have to be controlled manually.

.tasks.status

Replies with current status of all tasks.

.tasks.stop <task_name>

Stops a given task.

.tasks.start <task_name>

Starts a given task.

.tasks.restart <task_name>

Restarts a given task.

.piston.update

Updates the list of supported programming languages.

Portal 2

.portal2.?

Prints information about this module.

.portal2.map <map_name... = optional>

Posts an overview image of a give map. A random map will be chosen if no name is provided.

.portal2.discovery <discovery_name... = optional>

Posts showcase link of a give discovery. A random discovery will be chosen if no name is provided.

.portal2.leaderboard <map_name... = optional>

Lists the rankings of a given map.

.portal2.changelog <map_name...>

Lists the changelog of a given map.

.portal2.profile <user_name_or_steam_id_64... = optional>

Prints the profile of a given user.

.portal2.aggregated <user_name_or_steam_id_64... = optional>

Prints the profile of a given user.

.portal2.compare <user_name_or_steam_id_64> <user_name_or_steam_id_64_2 = optional>

Compares two user profiles. Username or nickname of command executor will be taken as second profile to compare to if the second argument is not provided.

Service

Note: Requires to have special permission.

services.?

Prints help and information of all available webhook services.

services.speedruncom.subscribe

Subscribes to the speedrun.com service.

services.speedruncom.unsubscribe

Unsubscribes to the speedrun.com service.

services.auditor.subscribe

Subscribes to the auditor service.

services.auditor.unsubscribe

Unsubscribes to the auditor service.

Source

.cvars.?

Prints information about the SourceEngine console command module.

.cvars.halflife2 <cvar>

Looks up a given console command for Half-Life 2.

.cvars.portal <cvar>

Looks up a given console command for Portal.

.cvars.portal2 <cvar>

Looks up a given console command for Portal 2.

.cvars.sourceautorecord <cvar>

Looks up a given console command for SourceAutoRecord.

.demo

.demo.?

Prints information about the SourceEngine demo module.

.demo.parse

Parses an attached SourceEngine demo file. Asks to look for a demo file in the last 100 messages if no file was attached.

.demo.get

Prints demo information.

.demo.filestamp

Prints demo information.

.demo.protocol

Prints demo information.

.demo.servername

Prints demo information.

.demo.clientname

Prints demo information.

.demo.mapname

Prints demo information.

.demo.gamedirectory

Prints demo information.

.demo.playbacktime

Prints demo information.

.demo.playbackticks

Prints demo information.

.demo.playbackframes

Prints demo information.

.demo.signonlength

Prints demo information.

.demo.messages

Prints demo information.

.demo.messages <index>

Prints demo information.

.demo.gettickrate

Prints demo information.

.demo.gettickspersecond

Prints demo information.

.demo.adjustexact

Prints demo information.

.demo.adjustflag

Prints demo information.

.demo.adjust

Prints demo information.

Stats

.guild

Prints statistics about the current server.

.hierarchy

Prints the role hierarchy of the current server.

.channel

Prints information about the current channel.

.id <ascending = true>

Lists top user IDs of the current server.

.disc <ascending = true>

Lists top user discriminators of the current server.

.joined <ascending = true>

Lists top user joined dates of the current server.

.created <ascending = true>

Lists top user created dates of the current server.

.pin.champions <descending = true>

Lists top pin champions from the pin board of the current server.

.pin.pinners <descending = true>

Lists top pin pinners from the pin board of the current server.