An irc bot for writers.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
prompts
README.md
listbot.py
promptbot.py
selectTopic.py

README.md

Please note that the code in this repository is quite a bit out of date. Stayed tuned for a new release, coming soon.

##Promptbot

An irc bot for writers.

###Introduction

Someday, there will be some manner of introductory paragraph here. Today is not that day, however.

Promptbot is currently active in #WritingPrompts on SnooNet.

###Commands

To give Promptbot a command, type either "promptbot, ‹command›" or "!‹command›"

####General commands

  • lists » lists names of all lists currently in promptbot
  • random » random entry from any list in promptbot

####List commands

The following commands apply to any list. To specify the list, replace ‹listname› with the name of the list. Usually the list you'll want is "prompt." See example usage for further clarification.

  • ‹listname› » random entry from list
  • ‹listname› ‹keyword› » entry from list that has been tagged with ‹keyword›
    • Multiple keywords can be given, and it will return an entry tagged with at least one of the keywords.
    • If a match is found, the response will begin with the keyword. If no match is found, it will return a random entry from the list.
  • ‹listname› ‹#› » entry number # from list. Replace ‹#› with an actual number (integers only).
  • last ‹listname› » repeat most recently given entry from list

####List commands example: prompt list

  • To get a random entry from prompt list » prompt
  • To get a prompt about worldbuilding » prompt worldbuilding
    • Note: there may or may not actually be any prompts tagged with worldbuilding.
  • To get prompt #10 » prompt 10
  • To repeat the most recent prompt » last prompt

####Entry commands

  • add ‹listname› » add new entry to list
    • Syntax: entry text #tag #(tag with spaces) @(source)
  • index? » number of the most recently given entry
  • tags? » tags of the most recently given entry
  • source? » source of the most recently given entry
  • add tag ‹keyword› » add a tag to the most recently given entry
  • add source @(‹source text›) » add a source to the most recently given entry
  • remove tag ‹keyword› » remove a tag from the most recently given entry
  • remove source @(‹source text›) » remove a source from the most recently given entry

####Entry commands example: prompt

  • To add a prompt with text "Describe the entirety of a single characters life. 20 word limit." tagged "Flash Fiction" and "FF," and sourced to RyanKinder and www.amzn.com/B00JOVSYC2 » add prompt Describe the entirety of a single characters life. 20 word limit. #(Flash Fiction) #FF @(RyanKinder) @(www.amzn.com/B00JOVSYC2)

####Sprint commands

Sprints are informal competitions against other writers in the chatroom to write as much as you can within a certain period of time. Typically, sprints last 15 to 30 minutes. You are not required to share whatever you write during the sprint, though you are free to do so! Word counts are self-reported, but since there are no prizes for wordsprints, lying or making up ridiculous numbers would really only be cheating yourself (and annoying others).

  • sprint ‹delay #› ‹duration #› » start a ‹duration #› minute-long wordsprint in ‹delay #› minutes
    • Promptbot will give 1-minute warnings before the start and end of the sprint.
    • Winners are announced 1 › ‹duration #›/5 ‹ 10 minutes after the sprint ends.
  • join ‹#› » join a wordsprint with a starting count of ‹#› words
    • You don't need to use join to join a wordsprint, but otherwise promptbot will assume your starting wordcount is 0.
    • This command can be used at any time during the sprint to change your starting wordcount.
  • wordcount ‹#› » update your wordcount to ‹#›
    • wc ‹#› performs the same command.
    • Before the sprint begins, this will set your starting count. Once the sprint starts, it will set your current wordcount.
    • Promptbot will tell you the number of words you've written since your last update, and the total words written so far in the sprint.
  • wordcount » check the total number of words you have written so far for the current sprint
    • wc performs the same command.
  • wordcount ‹username› » check ‹username›'s wordcount for the current sprint
    • wc ‹username› performs the same command.
  • cancel » cancel a wordsprint
    • Only channel ops and the person who started the sprint can cancel it.

####Miscellaneous

  • smite ‹user› » this command does not exist, and probably never will if socialdisorder keeps bugging me about it ;)