home *** CD-ROM | disk | FTP | other *** search
/ PC Action 1996 May / PCA0596.ISO / gtarchiv / 02960015 / readme.txt < prev    next >
Text File  |  1995-11-03  |  12KB  |  320 lines

  1.  
  2.                      ╔════════════════════════════╗
  3.                      ║     TXB FILE UTILITIES     ║
  4.                      ║        FOR DESCENT         ║
  5.                      ╚════════════════════════════╝
  6.  
  7.             ────────────────────────────────────────────────
  8.                    These utilities are FREEWARE and 
  9.                    may be freely distributed.  This
  10.                    software must not be sold or bundled
  11.                    with any other software without my
  12.                    consent.
  13.  
  14.                    In other words, you can give it away
  15.                    but you can't make money off it.
  16.             ────────────────────────────────────────────────
  17.  
  18. If you can't wait and want to try it out now:
  19.  
  20.       Copy ROBOT.TXB, ROBOT.MSN, and SHORT.RDL to your descent directory
  21.       then run descent.  Start a new mission and select !ROBOT.
  22.       Note: The    levels are just a dummy level used to test the briefing
  23.       messages.
  24.  
  25.                          ╔═══════════════════╗
  26.                          ║ TABLE of CONTENTS ║
  27.                          ╚═══════════════════╝
  28.  
  29.                       1. Version Changes
  30.  
  31.                       2. What is a TXB file?
  32.  
  33.                       3. Creating TXB files
  34.  
  35.                       4. TXB file format
  36.  
  37.  
  38.                          ╔════════════════════╗
  39.                          ║ 1. VERSION CHANGES ║
  40.                          ╚════════════════════╝
  41.  
  42. Version 1.0:
  43.  
  44.       Note: Initial version.
  45.  
  46.  
  47. Files included with this version:
  48.       FILE_ID.DIZ  - Zip information file
  49.       TXT2TXB.EXE  - Text to TXB converter
  50.       TXB2TXT.EXE  - TXB to Text converter
  51.       README.TXT   - This file
  52.       ROBOT.TXT    - Sample briefing file which shows all the robots
  53.       ROBOT.TXB    - Converted ROBOT.TXT file
  54.       ROBOT.MSN    - Mission file which uses ROBOT.TXB
  55.       ROBOT.RDL    - Very short mission file used for testing briefings
  56.  
  57.                        ╔════════════════════════╗
  58.                        ║ 2. What is a TXB file? ║
  59.                        ╚════════════════════════╝
  60.  
  61. TXB files contain various text strings  for the game Descent.
  62.  
  63. Several TXB files are stored in the DESCENT.HOG file.  The release version
  64. of Descent contains the following files:
  65.  
  66.         DESCENT.TXB  - Contains game messages, warning messages, etc..
  67.         BRIEFING.TXB - Contains briefing text
  68.         CREDITS.TXB  - Lists the people who helped create Descent
  69.         ENDING.TXB   - Contains the closing briefing text for the shareware
  70.                        version of Descent
  71.         ENDREG.TXB   - Contains the closing briefing text for the released
  72.                        version of Descent
  73.         LEVELxx.TXB  - (where xx = 01 to 27, S1, S2, and S3).  Contains data
  74.                        for each of the 27 levels plus the three secret levels
  75.  
  76.  
  77.                         ╔═══════════════════════╗
  78.                         ║ 3. Creating TXB files ║
  79.                         ╚═══════════════════════╝
  80.  
  81.  
  82. The first thing you should do is convert the BREIFING.TXB file to a text
  83. file as follows:
  84.  
  85.   TXB2TXT briefing.txb briefing.txt
  86.  
  87. Now you can load the briefing.txt file into any text file editor.  You will
  88. notice commands which have a dollar sign in front of them followed by a
  89. letter.  These instruct DESCENT to preform certain actions as the TXB files
  90. are being displayed (see TXB file format below).  You will also see several
  91. paragraphs of text.  This is exactly what is displayed on the screen as you
  92. begin a level.
  93.  
  94. If you want to change the briefing text when you start the game, all you have
  95. to do is edit the BRIEFING.TXT file and convert it back to a TXB file.
  96. Descent will do the rest.
  97.  
  98.  
  99. Then you can put the following line in your MSN file:
  100.  
  101.         BRIEFING = MYBRIEF
  102.  
  103. This will take file file MYBRIEF.TXB and use it in place of the standard
  104. briefing file.
  105.  
  106. NOTE: This line should not be put between num_levels and the rdl file names
  107.       otherwise, Descent will think BRIEFING is the name of one of the levels.
  108.  
  109. You don't need to extract the TXB files from the HOG file unless you want
  110. to see what they look like.  Included in this zip is BRIEFING.TXB which
  111. gives you the format necessary for creating your own briefing messages.
  112.  
  113. There are several HOG file extraction utilities available on Compuserve in
  114. the Action Games forum.
  115.  
  116.                          ╔════════════════════╗
  117.                          ║ 4. TXB file format ║
  118.                          ╚════════════════════╝
  119.  
  120. TXB codes are a rotated and bit flipped version of ASCII.  The TXB2TXT 
  121. program reads in a code, rotates it by 2 bits and exclusive OR's it with
  122. a constant.  To convert back to TXB format, the program TXT2TXB does the
  123. reverse.
  124.  
  125. The following is a list of commands used in TXB files:
  126. $Sn    - Sequence number (starting with $S1, these must be in order)
  127.          Page breaks are automatically added before each $S number.
  128.          Each sequence number has a particular background picture and
  129.          each level has one or more sequence numbers as follows:
  130.  
  131.          Level    Sequence     Background Picture
  132.          ─────    ────────     ──────────────────
  133.      1      1           brief01.pcx
  134.            2           brief02.pcx
  135.            3           brief03.pcx
  136.            4           brief02.pcx
  137.            5           moon01.pcx
  138.      2      6           moon01.pcx
  139.      3      7           moon01.pcx
  140.      4      8           venus01.pcx
  141.      5      9           venus01.pcx
  142.      6      10           brief03.pcx
  143.            11           merc01.pcx
  144.      7      12           merc01.pcx
  145.      8      13           brief03.pcx
  146.            14           mars01.pcx
  147.      9      15           mars01.pcx
  148.      10      16           brief03.pcx
  149.            17           mars01.pcx
  150.      11      18           jup01.pcx
  151.      12      19           jup01.pcx
  152.      13      20           brief03.pcx
  153.            21           jup01.pcx
  154.      14      22           jup01.pcx
  155.      15      23           saturn01.pcx
  156.      16      24           brief03.pcx
  157.            25           saturn01.pcx
  158.      17      26           brief03.pcx
  159.            27           saturn01.pcx
  160.      18      28           uranus01.pcx
  161.      19      29           uranus01.pcx
  162.      20      30           uranus01.pcx
  163.      21      31           uranus01.pcx
  164.      22      32           neptun01.pcx
  165.      23      33           neptun01.pcx
  166.      24      34           neptun01.pcx
  167.      25      35           pluto01.pcx
  168.      26      36           pluto01.pcx
  169.      27      37           pluto01.pcx
  170.  
  171.          Note: I haven't figured a way of changing the number of sequences
  172.          per level yet or how to change which *.pcx file is loaded.  I
  173.          assume this must be hard coded in the game.  Luckly, the first level
  174.          has a bunch of screens so you can create lots of interesting
  175.          briefings.
  176.  
  177. $Cn    - Sets color
  178.            $C1 = Green (default)
  179.            $C2 = White
  180.  
  181. $Rn    - Specifies a robot to display (use only on sequences which
  182.          have a background picture with the correct color palette
  183.          such as brief03.pcx $S3,10,13,16,20,24 and 26).
  184.  
  185.            $R0  =  medium hulk
  186.            $R1  =  medium lifter
  187.            $R2  =  spider
  188.            $R3  =  class 1 drone
  189.            $R4  =  class 2 drone
  190.            $R5  =  invisible vulcan
  191.            $R6  =  invisible hulk
  192.            $R7  =  supervisor
  193.            $R8  =  secondary lifter
  194.            $R9  =  heavy driller
  195.            $R10 =  gopher, laser
  196.            $R11 =  platform, laser
  197.            $R12 =  platform, missile
  198.            $R13 =  red triangle
  199.            $R14 =  baby spider
  200.            $R15 =  miniboss
  201.            $R16 =  heavy hulk
  202.            $R17 =  big boss 1
  203.            $R18 =  invisible lifter
  204.            $R19 =  vulcan man
  205.            $R20 =  light hulk
  206.            $R21 =  advanced lifter
  207.            $R22 =  defense proto
  208.            $R23 =  big boss 2
  209.     
  210. $Bname - Specifies a brush to display on the screen
  211.          (these brushes look funny if the palette of the background
  212.           picture is not the same as the brush.  In fact, the only
  213.           brushes that I have found that work are moon01 to moon04
  214.           for sequences that use the background picture brief03.pcx
  215.           ($S3,10,13,16,20,24,26).
  216.  
  217.            $Blev01ter - ??? 
  218.            $Bearth    -    earth #1
  219.            $Bearth2   -    earth #2
  220.            $Bmoon01   - solid rectangle
  221.            $Bmoon02   - solid rectangle
  222.            $Bmoon03   -    solid rectangle
  223.            $Bmoon04   -    same as moon03.bbm
  224.            $Bempty    -    plane black
  225.            $Bsun      -    a sun
  226.            $Bendguy   -    same guy as in brief02.pcx except different palette
  227.  
  228. $Nanim - Specifies an animation to display.  There are two problems with
  229.          animations:
  230.          1) Animations with less than 15 tweens will display
  231.             a blue rectangle with an X through it for the upper tweens.
  232.          2) Animations which use the transparent color will not update
  233.             on the screen correctly.  Instead, you will see the left over
  234.             of the last tween when the new tween is drawn.
  235.          Because of these two limitations, it turns out that the only
  236.          animation which looks good is $Ndoor13 which is the exit door.
  237.          Oh, well....
  238.  
  239.            $Narw01  - red wall panel <<<<<<
  240.            $Nmisc17 - energy
  241.            $Nfan01  - rotating fan
  242.            $Nmntr04 - monitor
  243.            $Nmisc09 - green wall
  244.            $Nmisc11 - red wall
  245.            $Nctrl04 - vertical red on gray wall
  246.            $Nctrl02 - red veins on gray wall
  247.            $Nctrl03 - red cross on gray wall
  248.            $Nmisc14 - purple veins
  249.            $Nmisc16 - purple wall
  250.            $Nmisc049 - quarter circle
  251.            $Nmisc060 - monitor
  252.            $Nmisc061 - dual monitors
  253.            $Nmisc062 - bargraph on monitor
  254.            $Nmisc065 - rolling monitor
  255.            $Nmisc066 - large monitor
  256.            $Nmisc067 - monitor with spider robot
  257.            $Nmisc068 - monitor with world
  258.            $Nmisc069 - monitor with planet
  259.            $Nmisc073 - lava fall
  260.            $Neye01   - robot eye #1
  261.            $Nglow02  - glowing red wall
  262.            $Nlava02  - lava
  263.            $Nflare   - yellow wall
  264.            $Nmisc060b - broken monitor
  265.            $Nmisc061b - broken dual monitor
  266.            $Nmisc065b - broken computer
  267.            $Nmisc066b - medium broken monitor
  268.            $Nmisc068b - large broken monitor
  269.            $Nmntr04b  - small broken monitor
  270.            $Nmisc062b - broken bargraph monitor
  271.            $Nmisc060d - warning
  272.            $Nmisc061d - warning and snow on monitor
  273.            $Nmisc062d - danger
  274.            $Nmisc065d - snow on computer
  275.            $Nmisc066d - evacuate
  276.            $Nmisc068d - large warning
  277.            $Nmntr04d  - small monitor with snow
  278.            $Neye02    - robot eye #2
  279.            $Nrmap01   - map #1
  280.            $Nrmap02   - map #2
  281.            $Nrmap04   - map #4
  282.            $Nboss02   - boss robot eye
  283.            $Neye03    - robot eye #3
  284.            $Nwall01   - stone wall
  285.            $Ndoor04   - metel door
  286.            $Ndoor10   - metel door
  287.            $Ndoor08   - metel door
  288.            $Ndoor12   - metel door
  289.            $Ndoor14   - metel door
  290.            $Ndoor11   - stone door
  291.            $Ndoor17   - stone door 
  292.            $Ndoor18   - stone door 
  293.            $Ndoor19   - stone door 
  294.            $Ndoor20   - stone door 
  295.            $Ndoor21   - stone door 
  296.            $Ndoor22   - stone door 
  297.            $Ndoor23   - stone door 
  298.            $Ndoor25   - stone door 
  299.            $Ndoor26   - stone door 
  300.            $Ndoor29   - stone door 
  301.            $Ndoor30   - stone door 
  302.            $Ndoor31   - stone door 
  303.            $Ndoor05   - iris metal door 
  304.            $Ndoor28   - iris metel door
  305.            $Ndoor24   - prisioner door
  306.            $Ndoor13   - exit door
  307.  
  308. $P     - Page break (not needed if the next line is a $Sn)
  309.  
  310. $F     - Cursor Flash (at the end of the text).  Default is no flash.
  311.  
  312. $T nn  - Haven't been able to figure this one out yet.  I've tried various
  313.          numbers but they don't seem to do anything???
  314.  
  315.            T 30  = used for text only
  316.            T 70  = used when there is animation to display
  317.        T 90  = used for the ending sequence
  318.  
  319. -End of file-
  320.