WoWChat.Net -- README

WoWChat.Net is a library that facilitates creating chat bots for old versions of World of Warcraft.

WoWChat.Net is a clean rewrite to dotNet Core 6.x of the excellent scala-based WoWChat project with the focus on making a reusable library suitable for creating chat bots that can utilize not only Discord, but other chat and messaging platforms.

It does NOT support WoW Classic or Retail servers.

Currently supported versions are:

• Wrath of the Lich King (Tested with Ascension)
• Able to be used with other versions (e.g. Vanilla, Cataclysm) but currently not tested.

Features:

• Clientless (Does not need the WoW Client to be open or even installed to run - this means you can run a chat bot on something as small as a Raspberry PI or a $5/mo Digital Ocean droplet)
• Runs within a dotNet core program, without any dependencies, and therefore works on Windows, Mac, and Linux.

How it works

At its core, WoWChat.Net interacts with WoW private servers utilizing its binary TCP Socket protocol. Dotnetty is utilized as a networking framework. It is designed to be a library that can be used in any .Net Core based application such as creating/publishing a bot for Discord, via Twilios API, an MQTT or AMPQ-based Message broker, or even a chat section on a website via Signalr/WebSockets.

The main WoWChat class implements an IObservable interface, allowing chat messages, and other events, to be consumed via any IObserver implementation.

The included CLI sample project contains a command line interface that can be used to run the bot.

Usage

Add the NuGet package to your project:

dotnet add [PROJECT] package WoWChat.Net [--prerelease]

Add WoWChat dependencies to DI

.ConfigureServices((context, Services) => {
  var config = context.Configuration;

  services.AddWoWChat(config.GetSection("WoWChat"));
});

Implement an IObserver and subscribe to the WoWChat.Net.WoWChat observable

using WoWChat.Net;
using WoWChat.Net.Common;

var wowChat = scope.ServiceProvider.GetRequiredService<IWoWChat>();
var myObserver = new MyWoWChatObserver();
wowChat.Subscribe(WoWChat);
await wowChat.Run(stoppingToken);

A sample CLI program is included in the project.

DO NOT, under any circumstances, use this bot on an account with existing characters!

Even though this bot does not do anything malicious, some servers may not like a bot connecting, and GMs may ban the account!

*** This bot currently successfully connects to realm and game servers and publishes messages, however consider it to be a work in progress as other packet types are implemented***