SphtBot - version 3.01 build 540

About

• SphtBot was primarily designed to be an efficient Battle.net chat bot, with a BotNet layer for clan and database management, which supports logging on to Battle.net as StarCraft, Brood War, Japan StarCraft, Warcraft II, Diablo II, Lord of Destruction, Warcraft III, and The Frozen Throne; as well as the classic games Diablo, Diablo Shareware, StarCraft shareware, and the experimental text-mode gateway.
• Support for the enhanced "Kp_Version_1" BotNet protocol (with backward compatibility for all previous server revisions), the BinaryChat plugin API, multiple account profiles, local and remote (BNLS) version checking, SOCKS4/5 and HTTP proxies, Diablo II realm and game server, the WebChannel ISAPI, SVP (short visit protection) standard, and various chat encryption standards.
• Offers a basic, but highly useful and functional Internet Relay Chat (IRC) client which operates concurrently within the main UI much like BotNet. Note: If you intend to use the IRC client in several active channels, while also on Battle.net, you may want to set up a separate dedicated profile for IRC to reduce on-screen clutter.
• Supports downloading and rendering backward/forward-order icons.bni. Also supports all the Warcraft III (including World Cyber Games), StarCraft, Warcraft II, and classic Diablo icons.

Installation and notes

• Download and extract the contents of the zip to your personal SphtBot directory. If SphtBot fails to launch, you may be missing some required run-time DLLs. Download and install.
• The first time you run SphtBot, you will be prompted for various information that is required for the Battle.net connection. You should fill in the information that is relative to the product(s) which you intend to log on as. Please note that SphtBot stores a separate CD-key for every product, so you should select a product from the dropdown before entering a CD-key for it.
• Enable "Connect to Battle.net" to automatically connect to Battle.net when the bot starts up. /forceconnect is a useful command to override any delays caused by subsequent failed connection attempts.
• You can enter multiple comma-delimited addresses for Battle.net and BNLS, and bot will randomly choose an address each time.
• Use /display to configure basic color settings to your likings. If colorful names is enabled, a unique color is computed for each user and IRC #channel which is consistent for all iterations of SphtBot.
• Navigate the registry to access many additional settings (HKEY_CURRENT_USER\Software\Valhalla's Legends\Spht\SphtBot). When making changes to the registry, /reload will be sufficient for most options, but generally the bot should be restarted.
• Bot will download and use icons.bni and icons_STAR.bni if it is available. You can also use classic_icons.bni for additional icons. Open the About dialog to view all icons that are currently loaded into memory.
• Supports logging on with a pre-hashed password (X-SHA1 logon protocol only). To use this, you must specify a password in the format SHA1:<40 hex characters>. Use /randsha1 to generate a random password.
• The official Battle.net Logon Server (BNLS) is no longer active, so you should use a trusted and reliable third-party server. BNLS is optional and only used for version checking so users need not worry about juggling and updating game files. CD-key and password hashing is performed locally for all products so sensitive information is never transmitted plain-text over the network.

Creating a profile

• Launching the executable directly (with no command-line) will open the default profile. Simply run SphtBot with the command-line "myprofile" (no spaces) to create or launch a separate configuration profile, where "myprofile" (in quotes) is the name of your profile. For your convenience, I recommend creating a Windows shortcut to SphtBot with the necessary command-lines for each profile you've created. You DO NOT need to create multiple copies of the exe to access additional profiles.

Battle.net Product Setup

• StarCraft/Brood War: Copy StarCraft.exe, Storm.dll, and Battle.snp from your StarCraft install into the subdirectory 'StarCraft' in SphtBot's installation directory.
• Warcraft II: Battle.net Edition: Copy Warcraft II BNE.exe, Storm.dll, and Battle.snp from your Warcraft II install into the subdirectory 'War2BNE' in SphtBot's installation directory.
• Diablo II: Copy Game.exe (and optionally D2client.dll and Bnclient.dll if emulating older versions) from your Diablo II install into the subdirectory 'Diablo II' in SphtBot's installation directory.
• Diablo II: Lord of Destruction: Copy Game.exe from your Lord of Destruction install into the subdirectory 'Lord of Destruction' in SphtBot's installation directory.
• Japanese StarCraft: Copy StarCraftJ.exe, Storm.dll, and Battle.snp from your Japanese StarCraft install into the subdirectory 'Japan StarCraft' in SphtBot's installation directory.
• Warcraft III and The Frozen Throne: Copy Warcraft III.exe (and optionally Storm.dll and Game.dll if emulating older versions) from your Warcraft III install into the subdirectory 'Warcraft III' in SphtBot's installation directory.
• Diablo (classic): Copy Diablo.exe (and/or Diablo_s.exe for Shareware), Storm.dll, Battle.snp from your Diablo install into the subdirectory 'Diablo' in SphtBot's installation directory.
• StarCraft Shareware: Copy StarCraft.exe, Storm.dll, and Battle.snp from your StarCraft Shareware install into the subdirectory 'StarCraft Shareware' in SphtBot's installation directory.

Known issues

• Bot may sometimes appear out of sight when using multiple monitors. Close the bot, locate and edit registry setting "Window options" (KEY_CURRENT_USER\Software\Valhalla's Legends\Spht\SphtBot) and set it to 4 or 5, whichever works best.
• There has been several changes to classic Battle.net's infrastructure over the past couple years:
• The official Battle.net servers now use a new logon method for StarCraft involving Blizzard accounts which is currently not supported.
• Battle.net's new anti-spam system will sometimes drop messages arbitrarily without notifying the user, even if you aren't necessarily "spamming". There is currently no implemented solution to determine on the fly when this is happening. Tip: It currently appears that you will always get messages from users on your /friends list.
• Your CD-key may still be "in use" after reconnecting. CD-key usage tends to linger sometimes for a couple minutes after disconnecting.
• You can only use one non-Warcraft3 CD-key at a time on Battle.net now (instead of one per gateway), and the 8 connection limit is no longer per-gateway either. Also, CD-key spawning has been disabled for Warcraft II.
• There are several new restrictions, autobans, server-specific temporary CD-key/account bans, etc. I recommend entering multiple comma-delimited Battle.net servers for the bot to choose from to automatically evade some of these problems. Eg: 199.108.55.57, 199.108.55.58, 199.108.55.59 instead of useast.battle.net since the DNS can often resolve to the same address for hours at a time.
• You may sometimes get IP banned from Battle.net through no fault of your own. My sincerest apologies for the immense sense of acute hopelessness you feel when this happens.

Commands which can be entered using the user-input box

Special thanks

oper.dll

• oper.dll is a BinaryChat plugin that will transform SphtBot into a full-fledged Battle.net channel moderation bot, designed to safeguard Clan channels.
• This plugin was heavily inspired by Skywing's ZeroBot (the bot used to moderate Clan [vL]) and designed to be cross-compatible with its database and scripting system. If you are familiar with ZeroBot or NBBot you should have no problem using this plugin.
• Features: A highly flexible custom command system (including userdefined variables and advanced conditionals), an intuitive flags-based access control system coupled with a limited form of regular expression wildcard matching, and a powerful set of channel moderation functionality.
• The original readme is available for download.

TriviaBot.dll

• TriviaBot.dll is a BinaryChat plugin that will transform SphtBot into a fully-functional and stable trivia bot for hosting trivia games in your channel.
• The readme contains instructions for use and its features.

Plugin Developer Reference

struct PluginInformation;
struct StateInformation;

// User functions
typedef BOOL (WINAPI * SetInterfaceInformationProc)(PluginInformation * lpInterfaceInfo);
typedef BOOL (WINAPI * MessageHookProc)(DWORD dwConnectionId, BYTE MessageId,
										LPCVOID lpMessageData, DWORD nMessageSize,
										LPARAM lParam);
typedef BOOL (WINAPI * EnumChannelProc)(LPCSTR lpszUniqueName, LPCSTR lpszStatstring,
										DWORD dwFlags, DWORD dwPing, BOOL bInvisible,
										DWORD dwAccountNumber, DWORD dwRegAuthority,
										LPARAM lParam);
typedef BOOL (WINAPI * ConnectionHookProc)(DWORD dwConnectionId, DWORD dwEventCode,
										DWORDLONG qwPlatformId, LPARAM lParam);
typedef DWORD (WINAPI * PluginTimerProc)(DWORD dwTimeDelay, LPARAM lParam);
typedef BOOL (WINAPI * CommandHookProc)(LPCSTR lpszMessage, LPCSTR lpszSendingUser,
										BOOL bFromTelnet, LPARAM lParam);
typedef BOOL (WINAPI * EventHookProc)(LPARAM lParam);

// APIs
typedef BOOL (WINAPI * ClearMessageProc)(BYTE MessageId);
typedef BOOL (WINAPI * IsMessageSetProc)(BYTE MessageId);
typedef BOOL (WINAPI * SetMessageProc)(BYTE MessageId);
typedef BOOL (WINAPI * QueueMessageProc)(BYTE MessageId, LPCVOID lpMessageData,
										DWORD nMessageSize);
typedef BOOL (WINAPI * QueueChatMessageProc)(LPSTR lpszChatMessage, BOOL bFixD2Command);
typedef BOOL (WINAPI * QueryStateInformationProc)(StateInformation * lpStateInfo);
typedef BOOL (WINAPI * QueryChannelInformationProc)(EnumChannelProc lpCallback,
										LPARAM lParam);
typedef BOOL (WINAPI * CloseConnectionProc)(DWORD dwConnectionId);
typedef BOOL (WINAPI * SendConnectionMessageProc)(DWORD dwConnectionId, BYTE MessageId,
										LPCVOID lpMessageData, DWORD nMessageSize);
typedef BOOL (WINAPI * SetOutputColorProc)(BYTE ColorId);
typedef BOOL (WINAPI * WriteOutputTimestampProc)(void);
typedef BOOL (WINAPI * WriteOutputStringProc)(LPCSTR lpszString);
typedef BOOL (WINAPI * ProcessBotCommandProc)(LPCSTR lpszCommand);
typedef LPCSTR (WINAPI * GetRegistryPathProc)(void);
typedef BOOL (WINAPI * ResetAwayIdleProc)(void);
typedef HWND (WINAPI * GetWindowProc)(DWORD dwWindowId);
typedef BOOL (WINAPI * IsServiceProc)(void);
typedef HMENU (WINAPI * GetMenuProc)(DWORD dwMenuId);

struct PluginInformation {
	DWORD dwSize;

	ClearMessageProc PNetClearMessage;
	IsMessageSetProc PNetIsMessageSet;
	SetMessageProc PNetSetMessage;
	QueueMessageProc PNetQueueMessage;
	QueueChatMessageProc PNetQueueChatMessage;
	QueryStateInformationProc PSysQueryStateInformation;
	QueryChannelInformationProc PSysQueryChannelInformation;
	CloseConnectionProc PNetCloseConnection;
	SendConnectionMessageProc PNetSendConnectionMessage;
	SetOutputColorProc PUISetColor;
	WriteOutputTimestampProc PUIWriteTimestamp;
	WriteOutputStringProc PUIWriteString;

	HINSTANCE hBotNetClient;
#ifdef _PLUGIN_SUPPORTS_BOTNET
	BotNetConnectionState * lpBotNetConnection;
#else
	void * lpBotNetConnection;
#endif

	MessageHookProc MessageHook;		// non-const
	LPARAM MessageHookParam;		// non-const

	ConnectionHookProc ConnectionHook;	// non-const
	LPARAM ConnectionHookParam;		// non-const

	PluginTimerProc PluginTimer;		// non-const
	LPARAM PluginTimerParam;		// non-const

	CommandHookProc CommandHook;		// non-const
	LPARAM CommandHookParam;		// non-const

	HINSTANCE hPlugin;

	EventHookProc EventHook;		// non-const
	LPARAM EventHookParam;			// non-const
	HANDLE hPluginEvent;
};

struct PluginInformation2 : public PluginInformation {
	ProcessBotCommandProc PSysProcessBotCommand;
};

struct PluginInformation3 : public PluginInformation2 {
	GetRegistryPathProc PRegGetRegistryPath;
	ResetAwayIdleProc PNetResetAwayIdle;
	GetWindowProc PUIGetWindow;
	IsServiceProc PSysIsService;
	GetMenuProc PUIGetMenu;
};

struct PluginInformation4 : public PluginInformation3 {
	IsUserFilteredProc PFltIsUserFiltered;
	IsMessageFilteredProc PFltIsMessageFiltered;
	EnumUserFiltersProc PFltEnumUserFilters;
	EnumMessageFiltersProc PFltEnumMessageFilters;
	AddUserFilterProc PFltAddUserFilter;
	AddMessageFilterProc PFltAddMessageFilter;
	RemoveUserFilterProc PFltRemoveUserFilter;
	RemoveMessageFilterProc PFltRemoveMessageFilter;
	NotifyMsgProc PUINotifyMsg;
	EnumLoadedPluginsProc PSysEnumLoadedPlugins;
};