Added some example text to evform

This commit is contained in:
Griatch 2014-02-15 17:03:44 +01:00
parent 6198e59f04
commit ab1663c856

View file

@ -3,8 +3,8 @@
Mudform - a way to create advanced ascii forms Mudform - a way to create advanced ascii forms
WARNING: UNDER DEVELOPMENT. Evform does currently NOT support WARNING: UNDER DEVELOPMENT. Evform does currently NOT support
colour ANSI markers in the table. Non-colour forms should colour ANSI markers in the table. Non-colour forms should
work fully (so make issues if they don't). work fully (so make issues if they don't).
This is intended for creating advanced ascii game forms, such as a This is intended for creating advanced ascii game forms, such as a
@ -55,6 +55,7 @@ INVALID_FORMCHARS in this module). Form Rectangles can have any size,
but must be separated from each other by at least one other but must be separated from each other by at least one other
character's width. character's width.
Use as follows: Use as follows:
import mudform import mudform
@ -62,6 +63,9 @@ Use as follows:
# create a new form from the template # create a new form from the template
form = mudform.MudForm("path/to/testform.py") form = mudform.MudForm("path/to/testform.py")
(MudForm can also take a dictionary holding
the required keys FORMCHAR, TABLECHAR and FORM)
# add data to each tagged form cell # add data to each tagged form cell
form.map(cells={1: "Tom the Bouncer", form.map(cells={1: "Tom the Bouncer",
2: "Griatch", 2: "Griatch",