Table of Contents
- Introduction
- About BattleJesus
- Public message commands
- !cq
- !status
- !time
- !roll
- !pick
- !ping
- !startwar
- !conf/!conv
- !joinwar/!joinwar-last
- Private message commands
- !register
- !login
- !logout
- !password
- Dual message commands
- !count
- !energy
- !quote
- !wp
- !wiki
- !help
- !newword
- !prompt
- !api
- !name
- !flags
- Troubleshooting
Introduction
BattleJesus is a bot specifically designed to track and calculate WordWars, short periods of time where a writer tries to write as much as possible. Other features, such as tracking word counts, novel quotes, etc, were added in later versions. This manual lists all publically accessible bot commands, their syntax, their usage, and what they do. Please see Troubleshooting if you have technical issues with the bot.
About BattleJesus
Commands can be of one of three types:
- Public
- Private
- Dual
Public commands are issued in any channel where BattleJesus is joined. Private commands are issued in query, via notice or private message. Dual commands can be issued either as public commands, or as private commands, hence being called "dual" commands. Commands come in various flavors, specifically:
- WordWar related
- Login related
- Other
WordWar related commands relate specifically to WordWars. Examples of these are the commands !startwar and !status. Login related commands either assist in logging in and out with the bot, such as !register and !login, or require that you be registered and logged in with the bot, such as !count and !quote. Other commands neither require login or registration, nor are they related to WordWars. Examples of these would be !time and !cq.
Most commands will return a result, either publically, as is generally the case with public commands, or privately, which is always the case with private commands, and more often than not the result of dual commands.
Commands given in private message can generally be given without the "!" prefix, and this prefix can also be replaced by the bot's current nickname, followed by a colon, and then a space. For example, "!count" would become "BattleJesus: count".
Public message commands
!cq
Channel quotes, Usage: !cq [add|count|#|]
- !cq add <text> Add the text of <text> as a quote in the database.
- !cq count Returns the current number of quotes in the database.
- !cq <#> Returns the text of quote number <#>.
- !cq Returns the text of a random quote.
!status
Word War status, Usage: !status
!status Returns information about word wars currently active in the channel via private message.
!time
Time, Usage: !time
- !time Returns the current time of the bot (UTC+10).
!roll
Dice roll, Usage: !roll [#d##|#dF|#dW|1dWC]
- !roll #d## Roll a ##-sided die # times.
- !roll #dF Roll # Fudge dice.
- !roll #dW Roll # World of Darkness dice.
- !roll 1dWC Make a World of Darkness Chance Roll.
!roll
Pick from a list, Usage: !pick something, somethingelse{, anothersomething ...}
- !pick something, somethingelse{, anothersomething ...} Pick one of the options listed at random.
!ping
Ping (status check), Usage: !ping
- !ping Request a response from the bot to ensure that it's still online.
!startwar
Start a WordWar, Usage: !startwar # ##
- !startwar # ## Start a ## (maximum of 30) minute(s) long WordWar in # (maximum of 15) minute(s).
!conf/!conv
Conversion functions, Usage: !con[f|v] [#[f|c|kg|lb]]
- !conf/!conv [#[f/c]] Convert # in Fahrenheit (f) or Centigrade (c) to Centigrade or Fahrenheit.
- !conf/!conv [#[kg/lb]] Convert # in Kilograms (kg) or Pounds (lb) to Pounds or Kilograms.
!joinwar/!joinwar-last
Join a WordWar, Usage: !joinwar[-last] [eo@]war
- !joinwar [war] Join in the WordWar named war. Joining a WordWar will send you, in private message, the same notices that the bot sends to the channel.
- !joinwar eo@[war] Join in the WordWar named war, but only recieve the starting message and the ending message in private message.
- !joinwar-last Join the last WordWar for the channel, receiving all messages.
- !joinwar-last [eo@] Join in the last WordWar for the channel, only receiving the starting and ending messages.
Private message commands
!register
Registration, Usage: !register <password>
- !register <password> Register with the bot using <password> as your password. Your username will correspond to your current nickname. If the current nickname is already registered, you won't be able to register it a second time. If you forget your password, contact mat.
!login
Login, Usage: !login <password>
- !login <password> Login with the bot; login sessions last 60 minutes, but will expire earlier with !logout.
!logout
Logout, Usage: !logout
- !logout Expire your current login session.
!password
Change your password, Usage: !password <password>
- !password <password> If logged in, will change your password to the text contained in <password>
Dual message commands
!count
Word counts, Usage: !count [#|<username>|]
- !count # While logged in, adjust your word count by #. Negative numbers are currently disabled allowed. Positive is assumed by default. The maximum number you can increase your wordcount by is 5000.
- !count <username> At any time, you can check the word count of a user <username> if they are registered and have updated their wordcount.
- !count Check your current word count at any time.
!energy
Display energy, Usage: !energy
- !energy Sends a private message with the current amount of energy you have. Many commands cost a certain amount of energy to use. Note that most commands cost much less to use in private messages than in a channel, including !energy itself! Consider sending most commands to BattleJesus via private message.
!quote
Novel quotes, Usage: !quote [add|del|list all|<username<|#|]
- !quote add <text> Add the text of <text> as a quote from your novel while logged in. You are limited to five quotes at a time.
- !quote del # Remove your quote number # from the database, allowing you to add another quote, while logged in.
- !quote list all Lists all your quotes, quote numbers and text, while logged in.
- !quote <username> If <username> has quotes in the database, will display a random quote from them.
- !quote # Displays the text of quote number #.
- !quote Displays a random quote and the username associated with it.
!wp
Wikipedia link, Usage: !wp <topic>
- !wp <topic> Creates a URL/hyperlink for the page <topic> on Wikipedia.
!wiki
Custom Wiki link, Usage: !wiki <topic>
- !wiki <topic> Creates a URL/hyperlink for the page <topic> on the channel's custom Wiki.
!help
Help message, Usage: !help
!newword
Invent a new word, Usage: !newword #
- !newword Invents a new word that is roughly # characters long.
!prompt
Writing prompts, Usage: !prompt [add|count|#|]
- !prompt add <text> Add the text of <text> to the prompt database.
- !prompt count Displays the total number of prompts in the database.
- !prompt # Display prompt number #.
- !prompt Display a random prompt.
!api
NaNoWriMo Wordcount API interface, Usage: !api [u|r]count
- !api ucount # Display the current word count for user number #.
- !api rcound # Display the current word count for region number #.
!name
Random names, Usage: !name [add|info|[#|[<flags>]]]
- !name add <name> [<flags>] Add the text of <name> as a name with the flags (option) <flags>. See !flags for more info on flags.
- !name info <name> Find out information about the name <name>, if it exists.
- !name [# [-<flags>]] Get # random names (defaults to 1), with option flags <flags>
!flags
Name flags, Usage: !flags
- !flags Returns the following text: Gender flags are: w=woman's name, m=man's name, n=neutral/no gender, a=alien. Other flags: r=a realistic name, s=a science-fiction style name, f=a fantasy style name, h=a historical-sounding name.
Troubleshooting
If you're having issues with the bot, you should contact its maintainer, mat. If the bot generates a notice akin to "An error has occured, please contact mat and try again later", it has already logged this error, and in all likelihood, mat is probably working on it. If you continue to have the error and you can't contact mat in any chat room, email: mat at nanowrimo dot org.