AGI Room Generator
------------------

Contents
--------

1. Release notes
2. Conditions for use of this program
3. Requirements
4. Short introduction to using the program
5. Important note about PicEdit
6. Version History

RELEASE NOTES
-------------

The current release of this software is version 1.0 beta. Note that this is
a beta version of this software, and even though there are no KNOWN bugs,
that doesn't mean there aren't bugs in the software. See the conditions
for use of this program.

This is the first release of this program.

CONDITIONS FOR USE OF THIS PROGRAM
----------------------------------

This software is provided without any warranty of any kind, and use of this
software is AT YOUR OWN RISK. At the time of this release, there are no
known bugs in the software. Although there is no reason to believe that
this program will do any damage to your computer, it is a condition for use
of this program that the author will not be held responsible for any damages
that occur to your computer, the files stored on your computer, or to
anything else.

This program is provided free of charge, and you may distribute it freely,
as long as a copy of this readme file accompanies the executable file.

IF YOU DO NOT AGREE WITH THESE CONDITIONS OF USE, THEN DO NOT USE THIS
PROGRAM.

PROGRAM REQUIREMENTS
--------------------

This program requires Microsoft Windows 95 or later.

SHORT INTRODUCTION TO USING THE PROGRAM
---------------------------------------

This program can create very simple AGI picture resources that are intended
to help you create simple, cube-shaped indoor rooms for your AGI games. When
the program begins, the input boxes, etc., you see are as follows:

Border width:
        This is essentially the width of the room, in AGI pixels. If you
        specify the value 80 for this input box, then the AGI picture
        resource that is created will have a centered border that spans
        from x = 39 to x = 119. Note that, for centering purposes, odd
        numbers work better than even numbers.

        Minimum Value: 1
        Maximum Value: 159

Border height:
        This is essentially the height of the room, in AGI pixels. If you
        specify the value 80 for this input box, then the AGI picture
        resource that is created will have a centered border that spans
        from y = 43 to y = 123. Note that, for centering purposes, odd
        numbers work better than even numbers.

        Minimum Value: 1
        Maximum Value: 167

Border color:
        This is the color of the border that will surround the room (or
        you can think of it as the color of the see-through wall at the
        front of the room). This border must exist, but you can make it
        invisible if you choose a color that is the same as the area
        surrounding the room.

        Possible Values: one of the EGA colors selectable from the
                         drop down list
        Warnings: be careful choosing White as the border color, because doing
                  so can interfere with filling

Fill space that is not inside the border:
        If this box is checked, then the area surrounding the room will be
        filled with a color you specify. This allows you to black out all the
        parts of the picture that are not a part of the room you are drawing.

Fill color:
        This is the color that the area surrounding the room will be filled
        with. If you do not want a fill, it is preferable to uncheck the
        "Fill space that is not inside the border" box, because that will
        prevent unnecessary picture command codes from being added to your
        picture resource.

        Possible values: one of the EGA colors selectable from the
                         drop down list
        Warnings: be careful if the border color is set to white, because
                  the fill will enter the area that is supposed to be the
                  room

X offset of diagonals:
        This is the x component of the diagonal lines that go to the back wall
        of the room to create the illusion of three dimensions. Specifying
        a greater x offset will result in longer-looking side walls and
        a thinner back wall.

        Minimum Value: 0
        Maximum Value: 159
        Warnings: although 159 is a legal value, you should not specify
                  values for the x offset that will cause the diagonal lines
                  to go beyond the edge of the picture resource -- this can
                  cause unpredictable results and may result in your machine
                  rebooting or other problems; a future version of this
                  program may calculate a maximum x offset, but for now,
                  BE CAREFUL

Y offset of diagonals:
        This is the y component of the diagonal lines that go to the back wall
        of the room to create the illusion of three dimensions. Specifying
        a greater y offset will result in shorter-looking side walls and
        a shorter back wall.

        Minimum Value: 0
        Maximum Value: 167
        Warnings: although 167 is a legal value, you should not specify
                  values for the y offset that will cause the diagonal lines
                  to go beyond the edge of the picture resource -- this can
                  cause unpredictable results and may result in your machine
                  rebooting or other problems; a future version of this
                  program may calculate a maximum y offset, but for now,
                  BE CAREFUL

Add unconditional barriers to picture resource:
        If this box is checked, then the areas of the room that represent
        walls will be marked with unconditional barriers. Otherwise, it will
        be up to you to put in your own barriers to keep things from moving
        through the walls of your room.

When you have set all the options as you want them, click the Create button.
You will be prompted for a file name. After you provide one, the picture
file will be saved. To exit the program, click Quit.

IMPORTANT NOTE ABOUT PICEDIT
----------------------------

PicEdit does not check to see if a file that it is editing has been
modified since it was opened. Because of this, it is possible for you to
create a new picture resource and overwrite a resource you are editing
in PicEdit without the changes showing up in PicEdit. If you then save
your PicEdit file under the same name, you will lose the resource you just
created. Fortunately, it should not be difficult for you to get it back.

VERSION HISTORY
---------------

1.0 Beta
        - First release
