mirror of
https://github.com/RussellChamp/tilde-projects.git
synced 2026-10-28 00:22:34 +00:00
Fix the markdown
This ain't no wiki-text
This commit is contained in:
1 parent
380f580c1f
commit
52a9aaf7ac
1 file changed
+18
-22
@@ -1,4 +1,4 @@
|
|||||||
= MadLibs =
|
# MadLibs
|
||||||
Madlibs is a game where a player is asked for many different words that are
|
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
|
then inserted into an existing story template. Using different words results
|
||||||
in very different stories!
|
in very different stories!
|
||||||
@@ -6,18 +6,18 @@ in very different stories!
|
|||||||
The Madlib library contains several functions that assist in reading a .madlib
|
The Madlib library contains several functions that assist in reading a .madlib
|
||||||
files, querying a user for input, and constructing a resulting story.
|
files, querying a user for input, and constructing a resulting story.
|
||||||
|
|
||||||
= MadLibBot =
|
## MadLibBot
|
||||||
Madlibbot is an IRC bot that utilizes the madlibs library to play MadLibs in
|
Madlibbot is an IRC bot that utilizes the madlibs library to play MadLibs in
|
||||||
an IRC channel.
|
an IRC channel.
|
||||||
|
|
||||||
= Usage =
|
## Usage
|
||||||
The madlibbot resides in the "#madlibs" channel on the tilde.town server.
|
The madlibbot resides in the "#madlibs" channel on the tilde.town server.
|
||||||
Saying "madlibbot: startgame" will start a new game of madlibs
|
Saying "madlibbot: startgame" will start a new game of madlibs
|
||||||
When asked for a word, reply with "madlibbot: WORD". This is so multiple
|
When asked for a word, reply with "madlibbot: WORD". This is so multiple
|
||||||
players may banter in a channel without accidentally answering the bot.
|
players may banter in a channel without accidentally answering the bot.
|
||||||
Use the command "madlibbot: !quit" to end a game prematurely.
|
Use the command "madlibbot: !quit" to end a game prematurely.
|
||||||
|
|
||||||
= Format =
|
## Format
|
||||||
If you would like to make your own stories discoverable by madlibbot, create a
|
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").
|
directory named "madlibs" in your home directory (eg "/home/krowbar/madlibs").
|
||||||
Inside, add story templates that have the extension ".madlib" (eg
|
Inside, add story templates that have the extension ".madlib" (eg
|
||||||
@@ -26,25 +26,21 @@ in IRC.
|
|||||||
MadLib files are plain text and use double mustaches to denote words that will
|
MadLib files are plain text and use double mustaches to denote words that will
|
||||||
be filled in by a user. An example is below:
|
be filled in by a user. An example is below:
|
||||||
|
|
||||||
""" Short_Story.madlib
|
* Short_Story.madlib
|
||||||
This is a {{an adjective}} story.
|
> This is a {{an adjective}} story.
|
||||||
"""
|
|
||||||
|
|
||||||
When this story is run, the bot will ask users the following:
|
When this story is run, the bot will ask users the following:
|
||||||
"""
|
> madlibbot: Give me an adjective:
|
||||||
madlibbot: Give me an adjective:"
|
|
||||||
"""
|
|
||||||
|
|
||||||
= Future Plans =
|
and continue asking for word replacement until it runs out of words to replace.
|
||||||
|
|
||||||
|
# Future Plans
|
||||||
* Allow users to specify the full path to a madlib file.
|
* Allow users to specify the full path to a madlib file.
|
||||||
** Make sure you filter only "\*.madlib" files so you don't accidentally grant
|
* Make sure you filter only "\*.madlib" files so you don't accidentally grant elevated read permissions!
|
||||||
elevated read permissions!
|
* Allow story writers the ability to specify that a single answer should be used multiple times in a story
|
||||||
* Allow story writers the ability to specify that a single answer should be
|
* Maybe specified like {{#a noun#}} or {{#a noun#4}}
|
||||||
used multiple times in a story
|
* Create word-munging options that can be specified for a word to modify given user input
|
||||||
** Maybe specified like {{#a noun#}} or {{#a noun#4}}
|
* Capital - convert "foo" to "Foo"
|
||||||
* Create word-munging options that can be specified for a word to modify given
|
* AllCaps - convert "bar" to "BAR"
|
||||||
user input
|
* Numeric - convert "3" to "three"
|
||||||
** Capital - convert "foo" to "Foo"
|
* Ordinal - convert "3" to "third"
|
||||||
** AllCaps - convert "bar" to "BAR"
|
|
||||||
** Numeric - convert "3" to "three"
|
|
||||||
** Ordinal - convert "3" to "third"
|
|
||||||
Reference in new issue
Block a user