]> 4ch.mooo.com Git - 16.git/blobdiff - src/lib/modex/paledit/paledit.doc
wwww
[16.git] / src / lib / modex / paledit / paledit.doc
diff --git a/src/lib/modex/paledit/paledit.doc b/src/lib/modex/paledit/paledit.doc
new file mode 100755 (executable)
index 0000000..61d0b2e
--- /dev/null
@@ -0,0 +1,166 @@
\r
+PALEDIT - A Simple VGA 256 Color Palette Editor\r
\r
\r
+PALEDIT is distributed with MODEXnnn.ZIP, the general purpose MODE X\r
+Library for VGA Graphics.\r
\r
+WHAT YOU NEED TO RUN PALEDIT:\r
\r
+    * A Vga Monitor\r
+    * A Microsoft Compatible Mouse\r
\r
+    A Mouse is most definitely required, as the keyboard is used for\r
+    nothing except entering file names.\r
\r
+FILES NEEDED IN THE CURRENT DIRECTORY:\r
\r
+    PALEDIT.EXE  - The Palette Editor Program\r
+    CHARSETS.CS  - The Palette Editor's Internal Fonts\r
+    MOUSEIMG.CS  - The Palette Editor's Mouse Pointer\r
\r
+SAMPLE PALETTE FILE THAT SHOULD BE INCLUDED:\r
\r
+     RGB.PAL   - A Simple Palette with Reds, Greens, and Blues\r
+     PRIME.PAL    - A Simple Palette\r
+     GAMECOLR.PAL - A Bright Palette from a Game of mine.\r
\r
+WHAT IT EDITS:\r
\r
+     The VGA DAC Registers, all 256 of them.\r
\r
+HOW IT WORKS/FEATURES:\r
\r
+    PALEDIT allows the user to see the entire VGA Palette of 256 colors\r
+    and select and modify the RED, GREEN, and BLUE values of any individual\r
+    color (DAC) register.  The entire group of 256 colors can be saved to\r
+    a disk file for later retrieval.\r
\r
+    Individual "SLIDERS" show the current RED, GREEN, and BLUE color\r
+    components of the current color and allow them to be changed.\r
\r
+    The Following operations can be performed.\r
\r
+    * Raise, Lower, and set the RED, GREEN, or BLUE components.\r
+    * Copy the current RGB values to another Color (DAC) Register\r
+    * Brighten the selected color\r
+    * Darken and selected color\r
+    * Reset the selected color to its original state\r
+    * Blend an entire range of colors, creating a smooth\r
+      Transition from one color to another\r
+    * Optionally Lock out the first 16 colors to prevent\r
+      Accidental Modification\r
\r
+DESCRIPTION OF OBJECTS/FEATURES FROM THE TOP DOWN:\r
\r
+    COLOR SLIDERS:  In the upper left of the screen there are\r
+        Three Rectangular Boxes: One for each primary color:\r
+        RED, GREEN, and BLUE.  Each Box has an arrow at each\r
+        end, and a scale bar in the middle, connecting the two\r
+        arrows.  The scale bar is much like a thermometer,\r
+        indicating how much of that color is in the selected\r
+        color.  To the right of each Box, the name of the color\r
+        is indicated, along with the content color in the form\r
+        of a number from 0 to 63; where 0 means none of that\r
+        color goes into making the selected color, and 63 means\r
+        that the selected color is saturated with that color.\r
\r
+        Clicking the mouse on the slider's left arrow box will\r
+        decrease the amount of that primary color in the selected\r
+        color.  Holding the mouse button down will reduce the\r
+        color value all the way to 0.\r
\r
+        Clicking the mouse on the slider's right arrow box will\r
+        increase the amount of that primary color in the selected\r
+        color.  Holding the mouse button down will increase the\r
+        color value all the way to 63.\r
\r
+        Clicking the mouse on the scale bar will set the amount\r
+        of that primary color to the value the represents that\r
+        position on the slider.\r
\r
+    LOCK Button:  Clicking the button toggles the lockout of the\r
+        first 16 colors.  When they are locked out, they can not\r
+        be modified, and when selected the word "LOCKED" will\r
+        appear below the color # on the Color Information Display.\r
\r
+    LOAD Button:  Clicking this button will load the Palette file\r
+        that is named in the Palette File name box.  If no name is\r
+        given or no such file exists, then nothing will be loaded.\r
\r
+    SAVE Button: Clicking this button will save the current Palette\r
+        in a file using the name given in the Palette File Name Box.\r
+        If a Valid name is not provided, nothing will be saved.\r
\r
+    QUIT Button: Clicking this button will return you to DOS.\r
+        Nothing is saved, and no confirmation is given.\r
\r
\r
+    Color Information Display:  This Box is on the left side of the\r
+        Screen, below the Color Sliders.  It shows the number of the\r
+        currently selected color (from 0 to 255) and indicates if\r
+        that color is locked.  To the right of this box is a big\r
+        square showing the current color.\r
\r
+    LIGHTER Button:  Clicking this button will make the selected\r
+        color brighter.\r
\r
+    DARKER Button:  Clicking this button will make the selected\r
+        color darker.\r
\r
+    RESET Button:  Clicking this button will restore the selected\r
+        color to the value it had when it was first selected.\r
\r
+    BLEND Button:  Clicking this button will let you Blend a range\r
+        of colors together.  One end of the range of colors is the\r
+        currently selected color.  After Clicking the BLEND button.\r
+        You must click on the color at the other end of the range\r
+        in the Palette Display Box.  All of the colors in between\r
+        those two colors will be changed to represent a gradual\r
+        transition from the color at one end to the color at the\r
+        other end.\r
\r
+    PALETTE FILE NAME BOX:  This Text Box is used to enter the name\r
+        of a Palette file to load or the name to save the current\r
+        Palette as.  Just click on the Box, and it will change color\r
+        and a flashing cursor will appear.  Now you type in a filename\r
+        or edit the existing filename.  Press <RETURN> or click\r
+        outside the text box to end editing.\r
\r
+    PALETTE DISPLAY BOX:  This Box shows all 256 colors in an array\r
+        of 32 by 8 color blocks.  The Currently Selected Color will\r
+        have a Box around it.  Clicking on a color with the Left\r
+        Mouse button will make that color the new currently selected\r
+        color.  Clicking on a color with the Right Mouse Button will\r
+        copy the color value from the old selected color to it, before\r
+        it is made the new selected color.\r
\r
+    Message Bar:  At the very bottom of the screen, this Bar will display\r
+        information and messages for various functions.\r
\r
+PALETTE FILE FORMAT:\r
\r
+     BINARY image, in order of VGA DAC (Color) Number.  3 Bytes Per\r
+     Color, 256 Colors.  768 Bytes total.  The Files will be exactly\r
+     768 bytes in size.\r
\r
+    COLOR:\r
+        RED:    1 BYTE\r
+        GREEN: 1 BYTE\r
+        BLUE:   1 BYTE\r
\r
+    PALETTE:  Array (0 to 255) of COLOR\r
\r
+COMMENTS, QUESTIONS, BUG REPORTS, etc:\r
\r
+    Send the to the Author:  Matt Pritchard\r
\r
+    Through the 80xxx Fidonet Echo or\r
\r
+    Matt Pritchard\r
+    P.O. Box 140264\r
+    Irving, TX  75014\r
\r
+CREDITS:\r
\r
+    This Palette Editor was written in QuickBASIC 4.5\r