Skip to content

vL BotNet

Jump to bottom
Nate Book edited this page Dec 12, 2017 · 2 revisions

Author: Ribose

Version: 0.9.20171211

Description: Allows StealthBot to connect to Valhalla Legend's BotNet service alongside Battle.net.

Command:

  • /botnet <subcommand> [args]
    • Executes actions within the context of BotNet.
    • Available <subcommand>'s are:
      • get [setting]: Gets a setting by that name.
      • set [setting] [value]: Sets a setting by that name.
      • connect: Connects to the server in the saved settings. Default settings: Server is null string and Port is 0x5555.
      • close: Closes any active connection.
      • chat <message>: Sends normal chat. Current database.
      • em <message>: Sends emoted chat. Current database.
      • bc <message>: Sends normal chat to all users (may require permissions).
      • bcem <message>: Sends emoted chat to all users (may require permissios).
      • wh <user> <message>: Sends normal chat to the specified user.
      • whem <user> <message>: Sends normal chat to the specified user.
      • re <message>: Sends normal chat to the last whisper user.
      • reem <message>: Sends emoted chat to the last whisper user.
      • user <user>: Retrieves and displays information on the specified user.
    • Alias: /bn
    • Not implemented yet:
      • aliases for subcommands
      • subcommands for chat-locking and/or prefix-boxing, listing of users, interaction with the BotNet bot-syncing user database system, interaction with the BotNet account system, interaction with the BotNet command execution system.

Settings:

  • ConnectOnLoad (bool, default: False)
  • Debug (bool, default: False): Show debugging messages.
  • Server (string, default: empty): Server address.
  • Port (int, default: 0x5555): Server port.
  • BotName (string, default: empty): "hub" name
  • BotPass (string, default: empty): "hub" password
  • DatabaseName (string, default: empty): "database" name
  • DatabasePass (string, default: empty): "database" password
  • UseAccount (bool, default: True): Auto-logon to account on connect (causes the first-time prompt to appear and then is disabled)
  • AccountName (string, default: empty): "account" name
  • AccountPass (string, default: empty): "account" password
  • ChatDropOptions (int, default: 0): Use this to set what is negotiated on logon. Will be made more clear later.

Setup Example:

  • Server information [required]; get this from the person running the server:
    • /bn set Server <IP>
    • /bn set BotName <hubname>
    • /bn set BotPass <hubpass>
    • /bn set DatabaseName <dbname>
    • /bn set DatabasePass <dbpass>
    • Databases on BotNet serve as a "BNCS-like channel" of sorts, where chat can be localized, and a bot-syncing "user database" of user-to-flags mapping is stored. These can be synced and implemented on bots on the server, allowing for bots to share their user databases.
  • Setting up an acocunt [optional]:
    • /bn set AccountName <acctname>
    • /bn set AccountPass <acctpass>
    • /bn set UseAccount True
    • Accounts on BotNet serve as a way to ensure the same person/bot is being talked to across connection changes. Names are ensured to be unique in the user list. Think IRC NickServ identification.
  • Reload script or connect by command:
    • /bn set ConnectOnLoad True
    • /bn connect

This isn't the final version of the script, as some things are still to be completed.

Clone this wiki locally