============================================================================
          Dirty_Lims (Limmericks), v1.2 README! File by Dotoran
============================================================================

What Is It?
~~~~~~~~~~~
    This is an offshoot idea of those quote programs floating around. This
one displays one of one hundred random Limmericks of an Adult nature.

    This is the fourth Adult Pfile I've written for CNet Amiga. See the end
of this document for more info on the other three files.

How Is It Installed?
~~~~~~~~~~~~~~~~~~~~
    To set this file up, follow these simple steps:

1: Copy the "Dirty_Lims", "Dirty_Lims.dat" and "Dirty_Lims.txt" files to
   whichever directory works for you(like PFILES:, PFILES:ADULTS/, etc).

   The file is written to check the location it was launched from and use
   that path to find the other files.

2: Add the file "Dirty_Lims" somewhere in your Pfiles section as an Arexx
   Command file. I don't see a problem with adding it as a Multi-Use Pfile
   as all it does is READ data out of the ".dat" file, but you'll have to
   check this out if you're running a multiline system.

3: If you wish, you can also add the "LIM" command to your BBSMENU file by
   first loading the file "cnet:bbsmenu" into a text editor, then add the
   following line to the END of Menu # 2, Available Everywhere:

    LIM, LIMmericks   `1-   |   {#0pfiles:Dirty_Lims}
                       ^        ^  ~~~|~~~
                    Access  Control-Q `---> Use PATH you used in # 1 above.
                    Groups

   NOTE: If you discover you need to run this as an Exclusive Use Only,
         or "One Player At A Time", then change the "#0" above to "#1".

4: That's it! Your done! If you have no need of modifying the Limmerick
   data(ex: Adding, Editing, Deleting Limmericks), then you can delete the
   "Dirty_Lims.txt" file, as the command file does not use this file during
   it's operations. You can also delete THIS README! file if you won't be
   needing it anymore. Just make sure you keep a copy of the original file
   archive this came in for backup purposes. The best place to keep the
   archive & also keep it productive, would be in a Fellow SysOps UD Base,
   so other CNet SysOps can enjoy this file too! Thanks!

----------------------------------------------------------------------------

    Those SysOps still reading this file know WHY your still reading:

Near the beginning of the "Dirty_Lims" command file are NUMEROUS variables
you may wish to change to customize the look of this file on your systems.
Simple changes in color, graphics characters, screen positioning, etc. can
be just what it takes to make it look just THAT much different than the one
run on your next closest neighbor, while at the same time keeping your BBS
as unique as possible! Here's what the variables do:

The first four "z" variables define BACKGROUND colors, and may use any VALID
MCI Color Character you would normally use with the "\z" command. For those
not familiar with the VALID choices, they are: 0, 1, 2, 3, 4, 5, 6, and 7.

z1 - The Background color of the Border that appears around the Limmerick.
z2 - The Background color of the Title Text within the Border. (Top & Bottom)
z3 - The Background color of the INSIDE of the Border, where the Limmerick is.
z4 - The Background color of the SIDE BARS of the Border.

Hint: Try a value of "0" for "z4" to figure out why it was included here.

----------------------------------------------------------------------------

The next seven "c" variables define TEXT Colors used, and may use ANY VALID
MCI Color Character: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, a, b, c, d, e, and f.

c1 - Color of Line 1 of the Limmerick.
c2 - Color of Line 2 of the Limmerick.
c3 - Color of Line 3 of the Limmerick.
c4 - Color of Line 4 of the Limmerick.
c5 - Color of Line 5 of the Limmerick.
c6 - Color of the Border Text. (Both Top and Bottom)
c7 - Color of the Border Graphics Characters.

----------------------------------------------------------------------------

The next four variables define graphics used, screen positioning, and the
age restriction this file supports:

rb - Random Borders? (0=No; Use "gr" Value, 1=Yes; New Border Every RUN)
gr - Graphic Shape to Use? (Between 0 and 14) Try them ALL! See Below!
dn - Down How Many Lines Before Printing the Limmerick? (Not to Exceed 15)
ag - Youngest Age to View. Set to 16 and 15 yr olds CAN'T, but 16's CAN, etc.

If "rb" is set to "1", a NEW border will ONLY be generated if the file is
reused from the BBS, and NOT if the user chooses to view Another or Specify
another to view from within the file.

The "gr" shapes are defined as follows:

     0: Spaces Only. Set z1, z4, and c7 to "0" for NO BORDER.
     1: Single Line IBM Graphics.
     2: Double Line IBM Graphics.
     3: Single Vertical, Double Horizontal Line IBM Graphics.
     4: Double Vertical, Single Horizontal Line IBM Graphics.
     5: Light  IBM Texturing. (Sometimes called Dithering)
     6: Medium IBM Texturing. (Sometimes called Dithering)
     7: Heavy  IBM Texturing. (Sometimes called Dithering)
     8: Outside Bar Shapes (Using Up at Top, Down at Bottom, etc.)
     9: Inside  Bar Shapes (Using Down at Top, Up at Bottom, etc.)
    10: Inside  Side Bar, Solid Horizontal Bars at Top and Bottom.
    11: Outside Side Bar, Solid Horizontal Bars at Top and Bottom.
    12: Centered Squares. Foreground Color Surrounded by Background Color.
    13: Outside Bar Shapes. (Same as #8 above, but no Side Bars)
    14: Inside  Bar Shapes. (Same as #9 above, but no Side Bars)

It's hard to adequately describe how all the above shapes interact with each
other, and with the foreground and background colors you may choose, so feel
free to experiment, until you find the combination that works best for you!

----------------------------------------------------------------------------

The next three variables are used to define the PROMPT that appears BELOW
the frame of each Limmerick. There are currently three functions supported
from this prompt, but you have complete control over what you wish to CALL
these functions, which keys will ACTIVATE these functions, what words will
be DISPLAYED when one of these functions is used, and lastly, the COLORS and
WORDS to be used in the prompt. Below are the current contents of these
three variables, MINUS the MCI commands for better readability:

pr1='[A]nother, (S)pecific, (Q)uit: '
pr2='Another|(1-100):|Quit'
pr3='ASQ'

The "pr1" variable defines how you wish the prompt to LOOK, and what COLORS
you wish it to appear in. The SPACE at the end of the string is not needed,
but highly reccommended for better readability to the user.

The "pr2" variable contains three pieces of data separated by the | character
which the program uses to determine where one data item ENDS and the next
data item STARTS. For this reason, you should NOT use the | character for any
of your responses. The first data item is what will be printed if the first
command is issued, the second item is printed for the second command, etc.

The "pr3" variable contains the actual keys which will need to be pressed to
activate the commands. The entire contents of this variable should be nothing
more than three characters immediately following each other. As given, the
"A" key activates the "Another" command, "S" activates "Specific", etc.

Here is another way these variables could be set up as an example, again NOT
using any MCI Color Commands for readability's sake:

pr1='Type M for More, C to Choose One, or Q to Quit>'
pr2='More|Which One? |Quit Now!'
pr3='MCQ'

Also, the FIRST Command will always be the DEFAULT command which will be
used whenever the user presses any key OTHER than the three in "pr3". For
this reason, if you wish to make QUIT the default, you will need to make it
the FIRST Command in the prompt.

----------------------------------------------------------------------------

The last three variables stored in the program are only used if you wish to
ADD, DELETE, or MODIFY any of the Limmericks. Looking at the "Dirty_Lims.txt"
file, you should be able to figure out that there is one Limmerick per line
within the file. Each line in itself contains the 5 lines that make up a
Limmerick, each separated by a | character, so to ADD another Limmerick to
the list, you'd use this format:

    Line1|Line2|Line3|Line4|Line5

Note also that no SPACES were included RIGHT BEFORE or RIGHT AFTER any of
the | characters. Adding extra spaces will interfere with the programs built
in centering routines, and the lines of the Limmerick may not look centered.

The "total" variable should contain the TOTAL number of Limmericks found in
the ".txt" file, so if you ever ADD or DELETE any Limmericks, make sure you
update this variable.

The "size" variable will need to be updated if you ever ADD or MODIFY a
Limmerick and the line length exceeds this value(presently set to 200). This
value was ROUNDED UP from the highest existing Limmerick, which if I recall
was around 185 characters long, so it's possible you may not even need to
modify this variable. The line length I'm referring to is the actual line as
it appears in the ".txt" file, like the example shown above.

If you DO ever ADD, MODIFY, or DELETE Limmericks from the ".txt" file, you
will need to recreate an updated ".dat" file. The ".dat" file is a crunched
character type of file similar to those used in other areas of CNet. Using
this method makes it surprisingly FAST to locate and load any Limmerick in
less than 1 second. The "build" variable is an ON/OFF switch to the ".dat"
creator routine(located at the bottom of the command file). This extra code
is only used if "build=1". One thing to note for "build" is that both the
".txt" and ".dat" files MUST be located in the SAME directory as your main
"Dirty_Lims" command file, so if you have them stored elsewhere, you will
have to move the files TO this directory.

That's It! There Ain't No More!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    Once again, I wind up another one of these README! files. I hope you and
your users can get some use/enjoyment out of this product. It was a quickie
to take my mind off some of my bigger projects.

    If you're interested in other Pfiles of an Adult Nature, I've written
three others you may want to get your hands on:

Andrew & SherriAnn - These are two chat programs of an Adult Nature. Your
                     users can have a discussion with Andrew, a studly guy,
                     or SherriAnn, a voluptuous redhead.

    Future World Filename: Adult_Files.LHA (in the Arexx Pfiles UD Base)

Dirty Jokes Database - Contains 366 Dirty Jokes for every day of the year.
                       Can be configured to show todays, yesterdays, or
                       tommorrows, or any combination of the three, plus
                       MUCH MUCH more!

    Future World Filename: Dirty_Jokes_v3_5.LHA (Also in the Arexx Area)

                                                                  - Dotoran
============================================================================
            Written by Dotoran of Frontiers BBS (716)/823-9892!
============================================================================
