home *** CD-ROM | disk | FTP | other *** search
/ Mega Top 1 / os2_top1.zip / os2_top1 / APPS / SPEL / DEPMV106 / DOOMEDPM.DOC < prev    next >
Text File  |  1995-01-15  |  12KB  |  309 lines
  1.  
  2. DoomEdit/PM - OS/2 PM DOOM MAP Editor
  3.  
  4. [ WEIRDWARE Release 1.06 ]
  5.  
  6. IMPORTANT:  BEFORE USING DEPM to create your own PWADs, make sure you go 
  7.             through the Tutorial; DEPM is very powerful, but there are some
  8.             tricks to using it.  If you do not know about these tricks,
  9.             you can really mess yourself (and your PWAD) up.
  10.  
  11. CONTENTS:
  12. -------------------------------------------------------------------------------
  13.  
  14. [1.0] A Note from the Author
  15.  
  16. [1.1] Disclaimer
  17. [1.2] Reporting Bugs
  18. [1.3] Changes From 1.00
  19. [1.4] Performance Hints / Known Bugs
  20. [1.5] Comments
  21.  
  22. [2.0] Introduction to DEPM
  23.  
  24. [2.1] Installation
  25. [2.2] Starting Up
  26. [2.2.1] Parameters
  27.  
  28. [3.0] What Now?
  29.  
  30. [4.0] WeirdWare
  31.  
  32. [5.0] History
  33.  
  34. -------------------------------------------------------------------------------
  35.  
  36.  
  37. [1.0] A Note from the Author
  38.  
  39. After countless hours of designing, programming, testing and debugging,
  40. DEPM V1.06 is finally done.  This project has been a real learning
  41. experience for me; not only have I learned a great deal about OS/2 PM
  42. programming, but I have created a high-quality application which makes
  43. DOOM map editing fun and easy, and which I can take pride in.
  44.  
  45. Enjoy!
  46.  
  47.  
  48. [1.1] Disclaimer
  49.  
  50. DEPM runs under OS/2 2.1 and OS/2 WARP, and supports DOOM and DOOM2.  
  51. A 256-colour display driver and use of the mouse is required.  DEPM 
  52. will not behave properly on systems using a 16-colour display driver.
  53. It may even crash!  On my system it works with 16-colours, but the
  54. textures are difficult to recognize.  With 64k colours, the wood
  55. actually looks like wood.
  56.  
  57. DOOM is a trademark of id Software.  If you are playing with an illegal
  58. copy, please shell out the cash to register.
  59.  
  60. Any damages incurred by using DOOM or DEPM are solely your reponsibility.
  61. DEPM is extremely stable, but nothing is ever bug-free.  No, there isn't
  62. any code in here which could hit your DOOM.WAD or format your disk, but
  63. if it crashes after a couple of hours of editing, and you have disabled
  64. autosave, I'm not going to drive to your house to reconstruct your lost
  65. map.  I would appreciate it if you let me know, though.
  66.  
  67.  
  68. [1.2] Reporting Bugs
  69.  
  70. If you find bugs, please let me know what exactly you did, and how 
  71. DEPM messed up.
  72.  
  73. My Internet mail address is:  Gerald.Callow@WPCUsrGrp.MB.CA
  74.                          or:  callow@mbnet.mb.ca
  75.  
  76. [1.3] Changes From 1.00
  77.  
  78. Some of the windows were taking too long to dismiss.  I've changed this
  79. so hopefully it'll improve dismiss time.  
  80.  
  81. Added a Memory Owned thing to let you know how much memory DEPM thinks
  82. it's using.
  83.  
  84. Right-click on an object now brings up a popup which allows you to
  85. delete the object (or flip/swap for linedefs).
  86.  
  87. Put in INI version recognition in so DEPM doesn't try to use
  88. incompatible profiles from previous versions.
  89.  
  90. Put in semaphores to stop the rendering thread from locking out
  91. the main thread.
  92.  
  93. Added palette saving and loading.  Some invisible (to you) bugs were fixed.
  94.  
  95. Added light level on sector identification, and sector properties
  96. applicator.
  97.  
  98. Added preload textures and render into bitmaps pereferences.
  99.  
  100. Added colour preferences dialog and functionality.
  101.  
  102.  
  103. [1.4] Performance Hints / Known Bugs
  104.  
  105. The Palette requires approximately 15 meg of memory.  If you're low on
  106. memory or swap space, DISABLE it.  I was not aware that the palette was
  107. quite this large because the memory for the bitmaps is owned by the
  108. system and DEPM doesn't know about it.
  109.  
  110. If you use the Palette, and have 15 meg of disk space that you don't mind
  111. losing, save the Palette to disk.  The palette will be loaded from disk
  112. automatically the next time you start DEPM.  The file will be called
  113. <profile>.DTP; if you want, you can delete it:  DEPM will just start
  114. rendering the palette again the next time you start it up.
  115.  
  116. Don't use MEMMAN=...,COMMIT under Warp, or else!
  117.  
  118. Performance improves when DEPM has less to draw, so don't edit at
  119. 10% scale.
  120.  
  121. Rebuilding levels takes a while and may interfere with "mode hopping"
  122. (jumping out of linedefs mode for two seconds, then jumping back
  123. in again).  I recommend you turn off Autobuild and then turn it
  124. back on to rebuild your map before you save it.
  125.  
  126. Autosave also cleans up memory, so don't disable it.
  127.  
  128. Sometimes when the node builder starts up while textures are being
  129. rendered, these two threads "block" the main thread for whatever
  130. time your MAXWAIT is set to.  Once the main thread gets control back,
  131. everything is OK.  I use MAXWAIT=2.  I've put in mutex semaphores
  132. in an attempt to keep the other threads from running amok.  If this
  133. happens to you, just wait a few seconds until the main thread gets
  134. control again.
  135.  
  136.  
  137. [1.5] Comments
  138.  
  139. It has been reported that under Warp, there is a memory leak in some
  140. of the video drivers.  I cannot verify this because it seems fine
  141. on my system (using Cirrus Logic 800x600x64k / 800x600x256).
  142.  
  143. Warp swaps more than 2.11:  quite a bit more, actually.
  144.  
  145. Heretic lookup tables will be put in when I get my grubby little paws
  146. on the registered version.
  147.  
  148.  
  149. [2.0] Introduction to DEPM
  150.  
  151. DoomEdit/PM (DEPM) requires practice to use, mainly because the optimal 
  152. method of building a level from scratch is completely the opposite to
  153. that of other editors.  For instance, in other editors you add vertexes 
  154. then linedefs; in DEPM, you can add vertexes only to existing linedefs.
  155.  
  156. DEPM provides you with a Tutorial as well as fully-functional online
  157. help.  This .DOC will not reproduce all of the information in these
  158. documents, so it is suggested you go through the Tutorial and use DEPM's
  159. online help to clarify anything you aren't clear on.
  160.  
  161. Remember, if you get stuck, or the help is unclear, or you want to know
  162. how to do something, you can always send me mail.  Turnaround time will
  163. be a day or two, so it might be worth your while to experiment a little 
  164. before giving up.  Try going through the help/Tutorial first.
  165.  
  166. DEPM makes all sorts of backups for you in case you do something you
  167. really didn't want to:  it creates an AUTOSAVE.WAD every so often, and
  168. any PWADs you read in are copied to <name>.BWD (Backup WAD).  You can
  169. enable/disable these options if you like.
  170.  
  171.  
  172. [2.1] Installation
  173.  
  174. Make a directory called DOOMEDPM and put all the files in it.
  175. Create a program object for DOOMEDPM.EXE.  Stick the
  176. program object in a folder, or on the desktop.  Set the working 
  177. directory to the DOOMEDPM directory.
  178.  
  179.  
  180. [2.2] Starting Up
  181.  
  182. Double-click on the DEPM icon to open the program.  It will display a file
  183. dialog asking for the DOOM.WAD.  Find your DOOM.WAD and hit "OK".  DEPM
  184. saves the location of the DOOM.WAD to its INI file for subsequent runs.
  185. If you don't move your WAD or erase DOOMEDPM.INI, you shouldn't have to
  186. do this again (unless you create a new profilel, or move to a new version
  187. of DEPM in which the profile changes).
  188.  
  189. [2.2.1] Parameters
  190.  
  191. There is one parameter only, and it is optional.  The parameter is the
  192. "profile" you want to use within DOOMEDPM.  Only the first eight (8)
  193. characters are significant.  This key is used to uniquely identify the
  194. profile within DOOMEDPM.INI; each time you pass DEPM a unique profile
  195. key, a new profile is created.  This allows you to create multiple program
  196. objects on your desktop (for example, DEPM for DOOM and DEPM2 for DOOM2).
  197. One program object can default, the other can explicitly pass a different
  198. profile key (for instance, DOOM2).  You can have as many different
  199. profiles as you wish.  The Default is "DoomEdPM".
  200.  
  201.  
  202. [3.0] What Now?
  203.  
  204. Start DEPM and go through the Tutorial!  The whole idea of having online
  205. help is that YOU don't have to read how to do things here, and even
  206. better, I don't have to write how to do things here.
  207.  
  208.  
  209. [4.0] WeirdWare
  210.  
  211. Feel free to give copies of this program to anyone who has OS/2 and DOOM.
  212. Feel even more free to give copies of this program to anyone who works at
  213. id Software.  Or any branch of IBM devoted to writing games for OS/2.  
  214. Or anyone else who might hire me and pay me lots.
  215.  
  216. This program is "WeirdWare"; this is a concept I invented and which can
  217. be a lot of fun:  if you like this program and continue to use it, please
  218. send me something.  If you want to send money, go right ahead.  If you want
  219. to e-mail me UUENCODED PWADs, that's fine too.  If you want to send me rude
  220. postcards, marbles, pocket lint, Elvis souvenirs, women, bits of cardboard,
  221. skateboard wheels, tapes, books of T.S. Eliot poetry, ABBA 45's, car parts,
  222. and/or pieces of string, that's even better.
  223.  
  224. The object of "WeirdWare" is to send me something that I would not expect
  225. to get in the mail, and which will make me laugh.  No human body parts
  226. or fluids, please.  My mailing address is:
  227.  
  228. Gerald Callow
  229. 633 Melrose Avenue West
  230. Winnipeg, MB
  231. R2C 1P6
  232. CANADA
  233.  
  234. Gerald.Callow@WPCUsrGrp.MB.CA
  235. callow@mbnet.mb.ca (or Gerald_Callow@mbnet.mb.ca)
  236.  
  237.  
  238. [5.0] History
  239.  
  240. Pre-DEPM - Kev says "Write an OS/2 doom editor or I'll break your
  241.            face."  I say "Um...yes, I will do this thing."
  242.  
  243. Version 0.00
  244. Implemented basic skeleton, file dialogs and menu progressions for
  245. WAD files.  
  246.  
  247. Version 0.10
  248. Implemented skeleton routines and dialogs for map selections
  249. and dialogs for editing.  Most window routines defined.  Basic
  250. IWAD recognition and palette loading.  Most menu functionality
  251. put in place and coded.  
  252.  
  253. Version 0.2
  254. PWADs can be loaded and saved.
  255.  
  256. Version 0.3
  257. WAD menu functions fully implemented and crash-tested.  Everything
  258. seems to work fine.  NEW, OPEN, IMPORT, SAVE, SAVE AS, QUIT, DROP,
  259. and ALTER now work correctly.  Large multi-level PWADS can hog quite
  260. a bit of memory and will cause the SWAPPER.DAT to grow.
  261.  
  262. Version 0.4
  263. Map functions (except sectors) have been implemented.  These include drawing
  264. IWAD and PWAD maps, fully-functional scroll, zoom, grid, and snap.  Map
  265. elements (things, vertexes, linedefs) are identified by pointing to them
  266. with the mouse.  Linedef direction indicators have been implemented.  Mouse
  267. performance becomes impacted when moving over active map elements, due to
  268. object correlation.  I'm not sure how sectors will work yet.
  269.  
  270. Version 0.5
  271. Drag and drop editing has been implemented.  Linedef drawing is in place.
  272. Some polishing needs to be done on the UI behavior, but this can wait until
  273. a functional beta is in test.
  274.  
  275. Version 0.6
  276. Worked bugs out of texture rendering.  Implemented multiple drops and
  277. imports.  Implemented Autosave and the Nodes Builder.
  278.  
  279. Version 0.7
  280. Implemented preferences dialogs and released as Beta 0.70.
  281.  
  282. Version 0.8
  283. Implemented compression, checking and support for extra stuff and Doom2.
  284. Released as Beta 0.80.
  285.  
  286. Version 0.9
  287. Contains complete online help and tutorial.  Many bug fixes.  Behaviors
  288. corrected, Autobuild preference enabled.  Many more bug fixes.  
  289. DOOM <--> DOOM2 wall/floor texture conversion implemented.  Texture
  290. rendering and texture palette implemented.  Applicator implemented.
  291. Accelerator keys implemented.  Other goodies added.
  292.  
  293. Version 1.0
  294. Leaned and cleaned to run in less memory, some user requests implemented.
  295.  
  296. Version 1.06
  297. Performance enhancements, popup menus, light level indicator for
  298. sectors, sector applicator, palette saving and loading, render into
  299. bitmaps preference, preload textures preference, colour preferences.
  300.  
  301.  
  302. About the Author
  303. ----------------
  304. Gerald Callow is a professional programmer who rushes home from work every
  305. night to continue programming.  His interests include drinking ludicrous
  306. amounts of coffee, playing DOOM, writing OS/2 stuff, and sending mail to 
  307. asian girls.  So how the hell are ya?
  308.  
  309.