]> 4ch.mooo.com Git - 16.git/blobdiff - src/lib/modex/fontedit/csedit.doc
refresh wwww
[16.git] / src / lib / modex / fontedit / csedit.doc
diff --git a/src/lib/modex/fontedit/csedit.doc b/src/lib/modex/fontedit/csedit.doc
new file mode 100755 (executable)
index 0000000..97ff07e
--- /dev/null
@@ -0,0 +1,196 @@
+\r
+CSEDIT - A Simple Font Editor by Matt Pritchard\r
\r
\r
+CSEDIT is distributed with MODEXnnn.ZIP, the general purpose MODE X\r
+Library for VGA Graphics.\r
\r
+WHAT YOU NEED TO RUN CSEDIT:\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
+    CSEDIT.EXE  - The Font Editor Program\r
+    CHARSETS.CS - The Font Editor's Internal Fonts\r
+    PALETTE.CS  - The Font Editor's Palette\r
+    MOUSEIMG.CS - The Font Editor's Mouse Pointer\r
\r
+SAMPLE FONT FILE THAT SHOULD BE INCLUDED:\r
\r
+    SYSTEM.FNT   - The Font used by CSEDIT.EXE\r
+    INVERSE.FNT  - An Inverted version of SYSTEM.FNT\r
+    SPACEAGE.FNT - A Futuristic, Tech style font\r
+    ROM_8X8.FNT  - The Lower 128 characters from the VGA BIOS Rom\r
\r
+WHAT IT EDITS:\r
\r
+    8 by 8 character fonts, 128 characters at a time. 2 fonts at a time.\r
\r
+HOW IT WORKS/FEATURES:\r
\r
+    CSEDIT allows the user to edit 2 different font groups at a time,\r
+    which may be loaded and saved separately.\r
\r
+    A enlarged character grid allows the user to edit individual pixels\r
+    on a selected character.\r
\r
+    The Following operations can be performed on a single character or\r
+    simultaneously on a selected block of characters.\r
\r
+       * Shift the selected character(s) in any direction\r
+         with or without clipping at the edges.\r
+       * Vertically Flip the selected character(s)\r
+       * Horizontally Flip the selected character(s)\r
+       * Rotate the selected character(s) 90 Degrees Clockwise\r
+       * Rotate the selected character(s) 90 Degrees Counterclockwise\r
+       * Clear the selected character(s)\r
+       * Invert the selected character(s)\r
+       * XOR the selected character(s) with other character(s)\r
+       * AND the selected character(s) with other character(s)\r
+       * OR the selected character(s) with other character(s)\r
+       * Copy the selected character(s) to another position or font.\r
\r
+    An UNDO feature allows the reversal of the most recent operation.\r
\r
+DESCRIPTION OF OBJECTS/FEATURES FROM THE TOP DOWN:\r
\r
+    Character Grid:  (RED) Box in Upper Left corner of screen.  This is\r
+        where you edit an individual character. The Left Button sets the\r
+        pixel the mouse pointer is on, while the Right Button clears that\r
+        pixel.\r
\r
+    Scroll Buttons:  The Four Scroll Buttons are labeled with directional\r
+        arrows, and arranged in a diamond pattern.  Left Clicking on a\r
+        directional button will scroll the currently selected character\r
+        in that direction, with the pixels on the edge rolling off and\r
+        appearing on the other size.  Right Clicking will prevent the\r
+        pixels from rolling to the other side.\r
\r
+    Vertical Flip Button:\r
+    Horizontal Flip Button:  Clicking these buttons will flip the pattern\r
+        of the currently selected character(s) around the indicated axis.\r
+        i.e. the top row will be swapped with the bottom row, etc. or the\r
+        left row column will be swapped with right column, etc.\r
+        depending upon which button you push.\r
\r
+    Invert Button:  Clicking this button causes all pixels in the selected\r
+        character(s) to flip flop between on and off.\r
\r
+    Clear Button: Clicking this button erases the selected characters\r
\r
+    Rotate Buttons: Clicking these buttons will rotate the pattern in the\r
+        selected character(s) 90 degrees in the indicated direction.\r
\r
+    XOR Button: Clicking this button will let you XOR the currently\r
+        selected character(s) with other character(s) in either font.\r
+        The Button will turn RED, indicating that it is waiting for\r
+        you to click on the desired character (or upper left corner\r
+        of the desired block of characters) in either the Red or Green\r
+        Character Set Displays.  Clicking anywhere else will abort this\r
+        process without doing anything.  If you click on (any of) the\r
+        selected character(s) the operation is aborted.  If a block is\r
+        selected and the character you click on is in a position where\r
+        it can't represent the upper left corner of a block of the same\r
+        size, then the operation is not performed.\r
\r
+    AND Button & OR Button:  These buttons work just like the XOR Button\r
+        except that the Binary operation performed is either an AND or OR\r
+        depending upon which button you have selected.\r
\r
+    COPY Button: This button lets you copy a character or selected block\r
+        of characters to another area in the current font or the other\r
+        font.  After clicking, the button turns RED and works much like\r
+        the XOR Button.  Clicking on a valid position in either font\r
+        window will copy the selected character(s) to that location.\r
\r
+    MODE Button: Clicking this button toggles the editor between BLOCK\r
+        mode and CHARACTER mode.  The current mode is displayed on a plate\r
+        at the top of the screen, just to the right of the enlarged\r
+        character grid.  In character mode the plate will read "CHAR" and\r
+        the currently selected character is displayed just to the right\r
+        of the plate.  In Block mode the plate will read "BLOCK" and the\r
+        enlarged character grid is disabled.\r
\r
+    UNDO Button: Clicking this Button will UNDO or reverse the effects of\r
+        the most recent operation.\r
\r
+    QUIT Button: Clicking this button will return you to DOS.  Any loaded\r
+        fonts are not saved, and no confirmation is given.\r
\r
\r
+    GREEN FONT AREA:  This area displays one of the current fonts which\r
+        can be edited.  The characters are display in order from #0 to #127\r
+        from the upper left, going right, then down.  The Font Box is 32\r
+        characters wide and 4 characters Tall.  When the editor is in\r
+        character mode, just point at and Left Click on the character you\r
+        wish to edit and a Cyan box will appear around that character.\r
+\r
+      * If you Right Click on a character, the last current character,\r
+        which will still appear in the enlarged character grid, will be\r
+        copied onto the character you pointed at, replacing it.  This is\r
+        a shortcut for copying characters: You can hold the right button\r
+        down an fill in a large area with a single character pattern.\r
+        When the editor is in Block Mode, you select an area by clicking\r
+        on any corner of the desired block.  Then drag the mouse to the\r
+        opposite corner while holding down the left button.  A Cyan Box\r
+        will stretch to surround the selected block of characters.\r
\r
+    GREEN FONT FILE NAME BOX:  This Text Box is used to enter the name\r
+        of a font file to load or the name to save the current Green font\r
+        as.  Just click on the Box, and it will change color and a\r
+        flashing cursor will appear.  Now you type in a filename or edit\r
+        the existing filename.  Press <RETURN> or click outside the text\r
+        box to end editing.\r
\r
+    GREEN FONT LOAD BUTTON:  Clicking this button will load the font file\r
+        that is named in the Green File name box.  If no name is given or\r
+        no such file exists, then nothing will be loaded.\r
\r
+    GREEN FONT SAVE BUTTON:  Clicking this button will save the current\r
+        font in the Green Font Area under the name given in the File Name\r
+        Box.  If a Valid name is not provided, nothing will be saved.\r
\r
+    RED FONT AREA:  This is just the same as the GREEN FONT AREA; providing\r
+        you with the ability to copy and edit between multiple fonts.\r
\r
+    RED FONT FILE NAME BOX:  This works just like the GREEN FONT FILE\r
+        NAME BOX.\r
\r
+    RED FONT LOAD BUTTON:  This works just like the GREEN FONT LOAD BUTTON.\r
\r
+    RED FONT SAVE BUTTON:  This works just like the GREEN FONT SAVE BUTTON.\r
\r
+    Message Bar:  At the very bottom of the screen, this Bar will display\r
+        information and messages for various functions.\r
\r
\r
+FONT FILE FORMAT:\r
\r
+    BINARY Image, in order of character.  The format is identical to that\r
+    used by the VGA ROM.  The Files will be exactly 1024 (128 * 8) bytes\r
+    long.\r
\r
+    CHARACTER: 8 Bytes\r
\r
+    FONT: Array (0 to 127) of CHARACTER\r
\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 Font Editor was written in QuickBASIC 4.5\r
\r