src/lib/modex/fontedit/csedit.doc

   1 \r
   2 CSEDIT - A Simple Font Editor by Matt Pritchard\r
   3  \r
   4  \r
   5 CSEDIT is distributed with MODEXnnn.ZIP, the general purpose MODE X\r
   6 Library for VGA Graphics.\r
   7  \r
   8 WHAT YOU NEED TO RUN CSEDIT:\r
   9  \r
  10     * A Vga Monitor\r
  11     * A Microsoft Compatible Mouse\r
  12  \r
  13     A Mouse is most definitely required, as the keyboard is used for\r
  14     nothing except entering file names.\r
  15  \r
  16 FILES NEEDED IN THE CURRENT DIRECTORY:\r
  17  \r
  18     CSEDIT.EXE  - The Font Editor Program\r
  19     CHARSETS.CS - The Font Editor's Internal Fonts\r
  20     PALETTE.CS  - The Font Editor's Palette\r
  21     MOUSEIMG.CS - The Font Editor's Mouse Pointer\r
  22  \r
  23 SAMPLE FONT FILE THAT SHOULD BE INCLUDED:\r
  24  \r
  25     SYSTEM.FNT   - The Font used by CSEDIT.EXE\r
  26     INVERSE.FNT  - An Inverted version of SYSTEM.FNT\r
  27     SPACEAGE.FNT - A Futuristic, Tech style font\r
  28     ROM_8X8.FNT  - The Lower 128 characters from the VGA BIOS Rom\r
  29  \r
  30 WHAT IT EDITS:\r
  31  \r
  32     8 by 8 character fonts, 128 characters at a time. 2 fonts at a time.\r
  33  \r
  34 HOW IT WORKS/FEATURES:\r
  35  \r
  36     CSEDIT allows the user to edit 2 different font groups at a time,\r
  37     which may be loaded and saved separately.\r
  38  \r
  39     A enlarged character grid allows the user to edit individual pixels\r
  40     on a selected character.\r
  41  \r
  42     The Following operations can be performed on a single character or\r
  43     simultaneously on a selected block of characters.\r
  44  \r
  45        * Shift the selected character(s) in any direction\r
  46          with or without clipping at the edges.\r
  47        * Vertically Flip the selected character(s)\r
  48        * Horizontally Flip the selected character(s)\r
  49        * Rotate the selected character(s) 90 Degrees Clockwise\r
  50        * Rotate the selected character(s) 90 Degrees Counterclockwise\r
  51        * Clear the selected character(s)\r
  52        * Invert the selected character(s)\r
  53        * XOR the selected character(s) with other character(s)\r
  54        * AND the selected character(s) with other character(s)\r
  55        * OR the selected character(s) with other character(s)\r
  56        * Copy the selected character(s) to another position or font.\r
  57  \r
  58     An UNDO feature allows the reversal of the most recent operation.\r
  59  \r
  60 DESCRIPTION OF OBJECTS/FEATURES FROM THE TOP DOWN:\r
  61  \r
  62     Character Grid:  (RED) Box in Upper Left corner of screen.  This is\r
  63         where you edit an individual character. The Left Button sets the\r
  64         pixel the mouse pointer is on, while the Right Button clears that\r
  65         pixel.\r
  66  \r
  67     Scroll Buttons:  The Four Scroll Buttons are labeled with directional\r
  68         arrows, and arranged in a diamond pattern.  Left Clicking on a\r
  69         directional button will scroll the currently selected character\r
  70         in that direction, with the pixels on the edge rolling off and\r
  71         appearing on the other size.  Right Clicking will prevent the\r
  72         pixels from rolling to the other side.\r
  73  \r
  74     Vertical Flip Button:\r
  75     Horizontal Flip Button:  Clicking these buttons will flip the pattern\r
  76         of the currently selected character(s) around the indicated axis.\r
  77         i.e. the top row will be swapped with the bottom row, etc. or the\r
  78         left row column will be swapped with right column, etc.\r
  79         depending upon which button you push.\r
  80  \r
  81     Invert Button:  Clicking this button causes all pixels in the selected\r
  82         character(s) to flip flop between on and off.\r
  83  \r
  84     Clear Button: Clicking this button erases the selected characters\r
  85  \r
  86     Rotate Buttons: Clicking these buttons will rotate the pattern in the\r
  87         selected character(s) 90 degrees in the indicated direction.\r
  88  \r
  89     XOR Button: Clicking this button will let you XOR the currently\r
  90         selected character(s) with other character(s) in either font.\r
  91         The Button will turn RED, indicating that it is waiting for\r
  92         you to click on the desired character (or upper left corner\r
  93         of the desired block of characters) in either the Red or Green\r
  94         Character Set Displays.  Clicking anywhere else will abort this\r
  95         process without doing anything.  If you click on (any of) the\r
  96         selected character(s) the operation is aborted.  If a block is\r
  97         selected and the character you click on is in a position where\r
  98         it can't represent the upper left corner of a block of the same\r
  99         size, then the operation is not performed.\r
 100  \r
 101     AND Button & OR Button:  These buttons work just like the XOR Button\r
 102         except that the Binary operation performed is either an AND or OR\r
 103         depending upon which button you have selected.\r
 104  \r
 105     COPY Button: This button lets you copy a character or selected block\r
 106         of characters to another area in the current font or the other\r
 107         font.  After clicking, the button turns RED and works much like\r
 108         the XOR Button.  Clicking on a valid position in either font\r
 109         window will copy the selected character(s) to that location.\r
 110  \r
 111     MODE Button: Clicking this button toggles the editor between BLOCK\r
 112         mode and CHARACTER mode.  The current mode is displayed on a plate\r
 113         at the top of the screen, just to the right of the enlarged\r
 114         character grid.  In character mode the plate will read "CHAR" and\r
 115         the currently selected character is displayed just to the right\r
 116         of the plate.  In Block mode the plate will read "BLOCK" and the\r
 117         enlarged character grid is disabled.\r
 118  \r
 119     UNDO Button: Clicking this Button will UNDO or reverse the effects of\r
 120         the most recent operation.\r
 121  \r
 122     QUIT Button: Clicking this button will return you to DOS.  Any loaded\r
 123         fonts are not saved, and no confirmation is given.\r
 124  \r
 125  \r
 126     GREEN FONT AREA:  This area displays one of the current fonts which\r
 127         can be edited.  The characters are display in order from #0 to #127\r
 128         from the upper left, going right, then down.  The Font Box is 32\r
 129         characters wide and 4 characters Tall.  When the editor is in\r
 130         character mode, just point at and Left Click on the character you\r
 131         wish to edit and a Cyan box will appear around that character.\r
 132 \r
 133       * If you Right Click on a character, the last current character,\r
 134         which will still appear in the enlarged character grid, will be\r
 135         copied onto the character you pointed at, replacing it.  This is\r
 136         a shortcut for copying characters: You can hold the right button\r
 137         down an fill in a large area with a single character pattern.\r
 138         When the editor is in Block Mode, you select an area by clicking\r
 139         on any corner of the desired block.  Then drag the mouse to the\r
 140         opposite corner while holding down the left button.  A Cyan Box\r
 141         will stretch to surround the selected block of characters.\r
 142  \r
 143     GREEN FONT FILE NAME BOX:  This Text Box is used to enter the name\r
 144         of a font file to load or the name to save the current Green font\r
 145         as.  Just click on the Box, and it will change color and a\r
 146         flashing cursor will appear.  Now you type in a filename or edit\r
 147         the existing filename.  Press <RETURN> or click outside the text\r
 148         box to end editing.\r
 149  \r
 150     GREEN FONT LOAD BUTTON:  Clicking this button will load the font file\r
 151         that is named in the Green File name box.  If no name is given or\r
 152         no such file exists, then nothing will be loaded.\r
 153  \r
 154     GREEN FONT SAVE BUTTON:  Clicking this button will save the current\r
 155         font in the Green Font Area under the name given in the File Name\r
 156         Box.  If a Valid name is not provided, nothing will be saved.\r
 157  \r
 158     RED FONT AREA:  This is just the same as the GREEN FONT AREA; providing\r
 159         you with the ability to copy and edit between multiple fonts.\r
 160  \r
 161     RED FONT FILE NAME BOX:  This works just like the GREEN FONT FILE\r
 162         NAME BOX.\r
 163  \r
 164     RED FONT LOAD BUTTON:  This works just like the GREEN FONT LOAD BUTTON.\r
 165  \r
 166     RED FONT SAVE BUTTON:  This works just like the GREEN FONT SAVE BUTTON.\r
 167  \r
 168     Message Bar:  At the very bottom of the screen, this Bar will display\r
 169         information and messages for various functions.\r
 170  \r
 171  \r
 172 FONT FILE FORMAT:\r
 173  \r
 174     BINARY Image, in order of character.  The format is identical to that\r
 175     used by the VGA ROM.  The Files will be exactly 1024 (128 * 8) bytes\r
 176     long.\r
 177  \r
 178     CHARACTER: 8 Bytes\r
 179  \r
 180     FONT: Array (0 to 127) of CHARACTER\r
 181  \r
 182  \r
 183 COMMENTS, QUESTIONS, BUG REPORTS, etc:\r
 184  \r
 185     Send the to the Author:  Matt Pritchard\r
 186  \r
 187     Through the 80xxx Fidonet Echo or\r
 188  \r
 189     Matt Pritchard\r
 190     P.O. Box 140264\r
 191     Irving, TX  75014\r
 192  \r
 193 CREDITS:\r
 194  \r
 195     This Font Editor was written in QuickBASIC 4.5\r
 196  \r