home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1997 June / CDW0697.iso / Quake / NIVELES / QCEDIT.ZIP / QCEDIT.TXT < prev   
Encoding:
Text File  |  1996-11-19  |  7.1 KB  |  180 lines
  1. QCEditor v0.8 Beta
  2. ==================
  3.  
  4. Thank you for trying out QCEdit v0.8.  This project is two months in the
  5. making between another project by the author, Javier Heredia, called ID4Doom.
  6. I hope you will all enjoy using this product.
  7.  
  8. TABLE OF CONTENTS
  9. =================
  10.  
  11. I.   BASICS
  12. II.  QUAKE-C EDITING
  13. III. USING QCEDIT FOR QUAKE-C EDITING
  14. IV.  REQUIREMENTS
  15.  
  16.  
  17. I. BASICS
  18. ---------
  19.  
  20. Although the basics of Quake-C editing is a very complicated thing, like
  21. almost anything else you can master it if you put some focus into it.  A
  22. prime example would be the work QUAKE COMMAND (http://www.nuc.net/quake) is
  23. doing.  So far they have created an airplane for us to use and are currently
  24. working on a massive teamplay patch along with a QuakeKart (think
  25. Quake-MarioKart).  This kind of patch can be done by anyone if they try hard
  26. enough.
  27.  
  28.  
  29. II. QUAKE-C EDITING
  30. -------------------
  31. I won't bore you with the specifics, but be warned that if you do not know C,
  32. Quake-C will be Greek to you.  Mind you, I do not claim to be a master of
  33. Quake-C, but I'm a good programmer to make it easier for you. :)
  34.  
  35. The first thing you have to have in order to edit Quake-C is a QC compilier.
  36. So far there have been at least three that we will deal with.  The first is
  37. QCCDOS.EXE, which was the QCC compiled by John Carmack of id and released
  38. with the source code.  The second is QCCWIN.EXE (or sometimes just QCC.EXE),
  39. which is a Win32 port of the DOS version.  The third is ADVQCC.EXE which is
  40. a faster and less limited version of the Win32 version.  ADVQCC.EXE is also a
  41. Win32 application.  All three are availible at FTP.CDROM.COM under the
  42. /pub/idgames2/quakec/utils directory.
  43.  
  44. The next thing you need is id's own Quake-C code files.  They usually have
  45. .QC extensions with them and include a file called PROGS.SRC.  The PROGS.SRC
  46. file is what is read by the QC compilier.  The first line is the file it will
  47. create after it has completed compiling (usually PROGS.DAT).  The rest of the
  48. PROGS.SRC file is a listing of all the .QC files it will compile _IN ORDER_.
  49. This is important to remember because functions created in .QC files can be
  50. accessed by any .QC file that is compiled after the first .QC file.  That is
  51. why PLAYER.QC comes before any of the monster .QC.  PLAYER.QC contains the
  52. gib fucntions, and any .QC file that uses it _MUST_ be compiled after
  53. PLAYER.QC.
  54.  
  55. The final thing you need is to learn the language of Quake-C.  Since even I
  56. do not know this, you will need to read the Quake-C specs I have included
  57. with QCEdit.  Read them thoroughly or reference them if you need help, either
  58. way works.
  59.  
  60.  
  61. III. USING QCEDIT FOR QUAKE-C EDITING
  62. -------------------------------------
  63.  
  64. QCEdit is not a compilier, it is a front-end.  It will make your life a lot
  65. easier by making it easier to access your .QC files, compiling them, and run
  66. QUAKE with your patch with simple menu commands.  Other features are the
  67. ability to edit your PROGS.SRC file, make new .QC files (it will then append
  68. the file to the PROGS.SRC file), change patches inside the program, and list
  69. all availible patches.  We'll go into this one by one.
  70.  
  71. ACCESSING YOUR .QC FILES
  72. The first thing you must have is EDIT.COM in your path, or the same directory
  73. as QCEDIT.EXE.  If not, you cannot use this.  QCEdit will call EDIT.COM and
  74. you will do the bulk of your editing there.
  75.  
  76. NOTE: The next full version will probably include an internal text editor so
  77.       as to not make it dependant on outside programs, but so far all
  78.       attempts have failed.  If any of you have a good text editing source
  79.       code for Turbo Pascal v7.0, please send it my way and expect a HUGE
  80.       reward. (Just a thank you email...I'm just as poor as the next college
  81.       student. :)
  82.  
  83. COMPILING YOUR .QC FILES
  84.  
  85. QCEdit will search for a file called QCCDOS.EXE, QCC.EXE, or ADVQCC.EXE.  If
  86. do not have any of these, the included QCC.EXE will work for just about
  87. any computer.  Simply place QCC.EXE in the same directory as QCEDIT.EXE or
  88. in your path.  QCEdit will call the compilier you have and it will take care
  89. of everything.
  90.  
  91. NOTE: The next full version will probably NOT include an internal compilier,
  92.       although it'd be cool if it did. :) However, if any of you are crazy
  93.       enough to make a QCC for Turbo Pascal v7.0, send it my way.  Let's show
  94.       these C programmers that Turbo Pascal is a good language!
  95.  
  96. RUNNING QUAKE WITH YOUR .QC FILES
  97.  
  98. Before running QUAKE, make sure you have compilied your .QC files.  A line
  99. after the .QC files will display information about your current PROGS.DAT
  100. file (file size, date and time last modified) if it exists.  If it doesn't
  101. then you will not see this line.  Just run QUAKE and your patch will be run
  102. with QUAKE.
  103.  
  104. NOTE: The next full version will NEVER include an internal QUAKE since you
  105.       MUST have the full version of QUAKE to use any Quake-C patch.  This
  106.       program will make sure you have the full version, if not it will not
  107.       run _AT ALL_.
  108.  
  109. EDITING YOUR PROGS.SRC FILE
  110.  
  111. The PROGS.SRC file includes all information the compilier reads, therefore
  112. this is the most important file you must have.  If you need to compile new
  113. .QC files, they must be listed in the PROGS.SRC file or they will not be
  114. compiled.
  115.  
  116. NOTE: Nothing here.  I just love running gags. :)
  117.  
  118. MAKING NEW .QC FILES
  119.  
  120. With a simple keystroke, a new .QC file will be called and appended to the
  121. PROGS.SRC file.  Neat huh?
  122.  
  123. NOTE: Last one, I swear.
  124.  
  125. CHANGE PATCHES
  126.  
  127. All this does is read another PROGS.SRC and refresh the screen to match it's
  128. contents.  It's simply easier than exiting and restarting with a new patch.
  129.  
  130. NOTE: Okay, I lied, but this is the LAST one.
  131.  
  132. LIST AVAILIBLE PATCHES
  133.  
  134. This willl not look for PROGS.DAT files, but for PROGS.SRC files.  See the
  135. REQUIREMENTS section of this isn't working for you.
  136.  
  137. NOTE: See, I told it was the last one.
  138.  
  139.  
  140. IV. REQUIREMENTS
  141. ----------------
  142.  
  143. Several things must be here in order for QCEdit to run without errors (I
  144. hope ;).
  145.  
  146. PROGS.SRC
  147.  
  148. Most PROGS.SRC have the first line reading '../PROGS.DAT' which must be
  149. changed to read just 'PROGS.DAT'
  150.  
  151. .QC FILES
  152.  
  153. .QC Files must be in the same directory as your PROGS.DAT file and all files
  154. must be in a subdirectory off the main QUAKE directory.  In other words, if
  155. your QUAKE directory is C:\GAMES\QUAKE and the name of your patch is PROJECT,
  156. the PROGS.DAT, PROGS.SRC, and all .QC files must be in the
  157. C:\GAMES\QUAKE\PROJECT directory.  Understand?  Good.
  158.  
  159. QC Compilier
  160.  
  161. I've included one, but you many use any compilier called either QCCDOS.EXE or
  162. QCC.EXE which must either be in the same directory as QCEdit or in your path.
  163.  
  164. QCEDIT.INI
  165.  
  166. This will be created if one cannot be found.  DO NOT DELETE THIS.
  167.  
  168.  
  169. Well, that's all the information you need to use QCEdit v0.8 Beta.  I hope
  170. you enjoy using this product.  If you must get in touch with me just email me
  171. at the address below, and while your waiting for a reply, go check out the
  172. work being done on ID4Doom. :)
  173.  
  174. JAVIER HEREDIA
  175. Project Leader -- ID4Doom
  176. QCEdit v0.8 programmer
  177. JHERED02@serss1.fiu.edu
  178. http://www.fiu.edu/~jhered02
  179.  
  180.