mirror of
https://github.com/RussellChamp/tilde-projects.git
synced 2024-06-14 12:46:37 +00:00
Added madlibbot readme
This commit is contained in:
parent
1671c4f3cb
commit
380f580c1f
50
Code/irc/madlibbot/README.md
Normal file
50
Code/irc/madlibbot/README.md
Normal file
|
@ -0,0 +1,50 @@
|
||||||
|
= MadLibs =
|
||||||
|
Madlibs is a game where a player is asked for many different words that are
|
||||||
|
then inserted into an existing story template. Using different words results
|
||||||
|
in very different stories!
|
||||||
|
|
||||||
|
The Madlib library contains several functions that assist in reading a .madlib
|
||||||
|
files, querying a user for input, and constructing a resulting story.
|
||||||
|
|
||||||
|
= MadLibBot =
|
||||||
|
Madlibbot is an IRC bot that utilizes the madlibs library to play MadLibs in
|
||||||
|
an IRC channel.
|
||||||
|
|
||||||
|
= Usage =
|
||||||
|
The madlibbot resides in the "#madlibs" channel on the tilde.town server.
|
||||||
|
Saying "madlibbot: startgame" will start a new game of madlibs
|
||||||
|
When asked for a word, reply with "madlibbot: WORD". This is so multiple
|
||||||
|
players may banter in a channel without accidentally answering the bot.
|
||||||
|
Use the command "madlibbot: !quit" to end a game prematurely.
|
||||||
|
|
||||||
|
= Format =
|
||||||
|
If you would like to make your own stories discoverable by madlibbot, create a
|
||||||
|
directory named "madlibs" in your home directory (eg "/home/krowbar/madlibs").
|
||||||
|
Inside, add story templates that have the extension ".madlib" (eg
|
||||||
|
"My_Good_Story.madlib"). Underscores will be changed to spaces when displayed
|
||||||
|
in IRC.
|
||||||
|
MadLib files are plain text and use double mustaches to denote words that will
|
||||||
|
be filled in by a user. An example is below:
|
||||||
|
|
||||||
|
""" Short_Story.madlib
|
||||||
|
This is a {{an adjective}} story.
|
||||||
|
"""
|
||||||
|
|
||||||
|
When this story is run, the bot will ask users the following:
|
||||||
|
"""
|
||||||
|
madlibbot: Give me an adjective:"
|
||||||
|
"""
|
||||||
|
|
||||||
|
= Future Plans =
|
||||||
|
* Allow users to specify the full path to a madlib file.
|
||||||
|
** Make sure you filter only "\*.madlib" files so you don't accidentally grant
|
||||||
|
elevated read permissions!
|
||||||
|
* Allow story writers the ability to specify that a single answer should be
|
||||||
|
used multiple times in a story
|
||||||
|
** Maybe specified like {{#a noun#}} or {{#a noun#4}}
|
||||||
|
* Create word-munging options that can be specified for a word to modify given
|
||||||
|
user input
|
||||||
|
** Capital - convert "foo" to "Foo"
|
||||||
|
** AllCaps - convert "bar" to "BAR"
|
||||||
|
** Numeric - convert "3" to "three"
|
||||||
|
** Ordinal - convert "3" to "third"
|
|
@ -1,4 +1,4 @@
|
||||||
krowbar&^%2209&^%1528899514
|
krowbar&^%2211&^%1528995967
|
||||||
karlen&^%498&^%1527613440
|
karlen&^%498&^%1527613440
|
||||||
endorphant&^%682&^%1444775660
|
endorphant&^%682&^%1444775660
|
||||||
jumblesale&^%24&^%1426171214
|
jumblesale&^%24&^%1426171214
|
||||||
|
@ -39,7 +39,7 @@ synergian&^%22&^%1458152889
|
||||||
dheeraj&^%5&^%1456489270
|
dheeraj&^%5&^%1456489270
|
||||||
demobot&^%6&^%1454439605
|
demobot&^%6&^%1454439605
|
||||||
premysl&^%65&^%1461768606
|
premysl&^%65&^%1461768606
|
||||||
minerobbe&^%268&^%1522323944
|
minerobbe&^%268&^%1529052078
|
||||||
xkeeper&^%14&^%1461967961
|
xkeeper&^%14&^%1461967961
|
||||||
cosnok&^%807&^%1508878859
|
cosnok&^%807&^%1508878859
|
||||||
escobar&^%1&^%1475431401
|
escobar&^%1&^%1475431401
|
||||||
|
@ -57,9 +57,9 @@ mio&^%339&^%1506434277
|
||||||
archangel&^%464&^%1524447604
|
archangel&^%464&^%1524447604
|
||||||
tehfraga&^%263&^%1527511198
|
tehfraga&^%263&^%1527511198
|
||||||
sushi&^%10&^%1493253212
|
sushi&^%10&^%1493253212
|
||||||
troido&^%284&^%1528830675
|
troido&^%285&^%1529052063
|
||||||
gamebot&^%157&^%1528830687
|
gamebot&^%160&^%1529052049
|
||||||
nilaky&^%1144&^%1528826579
|
nilaky&^%1152&^%1529028413
|
||||||
bucket&^%103&^%1507931139
|
bucket&^%103&^%1507931139
|
||||||
lolbot&^%1&^%1502568407
|
lolbot&^%1&^%1502568407
|
||||||
m455&^%12&^%1512076715
|
m455&^%12&^%1512076715
|
||||||
|
@ -72,8 +72,8 @@ pinhook&^%8&^%1509744722
|
||||||
emfor&^%3&^%1509671353
|
emfor&^%3&^%1509671353
|
||||||
k2l8m11n2&^%11&^%1510932395
|
k2l8m11n2&^%11&^%1510932395
|
||||||
sacredpix&^%3&^%1522082931
|
sacredpix&^%3&^%1522082931
|
||||||
deltawitc&^%2003&^%1528899800
|
deltawitc&^%2018&^%1529022699
|
||||||
login&^%1133&^%1528853906
|
login&^%1147&^%1529054074
|
||||||
kelpiebot&^%3&^%1513101957
|
kelpiebot&^%3&^%1513101957
|
||||||
unreal&^%1&^%1514940020
|
unreal&^%1&^%1514940020
|
||||||
tildethie&^%3000&^%1521573658
|
tildethie&^%3000&^%1521573658
|
||||||
|
@ -93,7 +93,7 @@ saturn597&^%3&^%1521429369
|
||||||
cwmccabe&^%2&^%1521598124
|
cwmccabe&^%2&^%1521598124
|
||||||
lucidiot&^%28&^%1526201925
|
lucidiot&^%28&^%1526201925
|
||||||
tracer&^%1&^%1521744878
|
tracer&^%1&^%1521744878
|
||||||
jan6&^%533&^%1528899537
|
jan6&^%571&^%1529054825
|
||||||
jan&^%10&^%1522319160
|
jan&^%10&^%1522319160
|
||||||
etathetae&^%3&^%1522937843
|
etathetae&^%3&^%1522937843
|
||||||
eeeeeta&^%31&^%1527704747
|
eeeeeta&^%31&^%1527704747
|
||||||
|
@ -105,11 +105,13 @@ ne1&^%7&^%1524024485
|
||||||
Halian&^%32&^%1528360263
|
Halian&^%32&^%1528360263
|
||||||
lunasspec&^%4&^%1524164784
|
lunasspec&^%4&^%1524164784
|
||||||
bowlercap&^%3&^%1524165068
|
bowlercap&^%3&^%1524165068
|
||||||
littlebig&^%35&^%1528853503
|
littlebig&^%36&^%1529000570
|
||||||
severak&^%6&^%1528897303
|
severak&^%6&^%1528901245
|
||||||
ralph&^%4&^%1526980620
|
ralph&^%4&^%1526980620
|
||||||
benjaminw&^%69&^%1528849036
|
benjaminw&^%80&^%1529074458
|
||||||
von&^%113&^%1528896624
|
von&^%120&^%1529074049
|
||||||
ensis&^%150&^%1528817036
|
ensis&^%164&^%1529072988
|
||||||
simon&^%26&^%1527937489
|
simon&^%26&^%1527937489
|
||||||
benharri&^%48&^%1528851037
|
benharri&^%62&^%1529075403
|
||||||
|
cpb&^%3&^%1528930564
|
||||||
|
calmbit&^%4&^%1529073811
|
||||||
|
|
|
@ -1,2 +0,0 @@
|
||||||
The {{an adjective}}, {{a color}} {{an animal}} jumped over the {{an adjective}} {{a color}} {{an animal}}.
|
|
||||||
The End
|
|
Loading…
Reference in New Issue
Block a user