home *** CD-ROM | disk | FTP | other *** search
/ PC Gamer 2000 January / CD-Gamer_2000-01_04_cd.bin / games / tyrian2k.exe / data1.cab / Program_Executable_Files / Shipedit.doc < prev    next >
Encoding:
Text File  |  1999-10-07  |  17.4 KB  |  452 lines

  1. ════════════════════════════════════════════════════════════════════════════════
  2.  SHIPEDIT
  3.                                 release version
  4.                                                                      SHIPEDIT
  5. ────────────────────────────────────────────────────────────────────────────────
  6.  
  7. ┌─────────────────────────┐
  8. │  Problems?              │
  9. └─────────────────────────┘
  10. While we have encountered few problems with this program, we suggest you
  11. keep in mind that it is possible the program would prevent Tyrian from
  12. running correctly.
  13.  
  14. Actually, it is possible if you select weapons which are not normally
  15. available in the full game.  You are, after all, able to do things which
  16. are impossible to do with the game normally.  This is a cheat program.
  17.  
  18. If you are having problems running Tyrian and you think Shipedit is the
  19. cause, you should be able to solve it by deleting NEWSH$ from the Tyrian
  20. directory.
  21.  
  22.  
  23. ┌─────────────────────────┐
  24. │  Introduction           │
  25. └─────────────────────────┘
  26.  
  27. ShipEdit is a fairly straightforward program [aside from the graphical editor]
  28. and can be used to add your own customized ships to the game.  It is specially
  29. designed so it is difficult to cheat, but you can make sure you use any weapon
  30. you want while playing the game.
  31.  
  32. ┌─────────────────────────┐
  33. │  Warnings               │     <--  READ This FIRST
  34. └─────────────────────────┘
  35.  
  36. Different Tyrian Versions:
  37.  
  38.      ShipEdit will automatically detect which version of Tyrian you are using.
  39. I would suggest using the latest version, but this program does have
  40. automatic backward compatibility when compiling.  It will show in the editor
  41. screen what version you are using.
  42. [0-1 is version 1.0 or 1.1 - ShipEdit cannot discern between them.
  43.    2 is version 1.2 or higher.]
  44.  
  45. USER.SHP
  46.         This is the user data file.  This file contains the current editor data
  47.         used by ShipEdit, including all the ship graphics you have drawn, the
  48.         ship weapon data, etc.
  49.  
  50. USER2.SHP & USER3.SHP
  51.         Two additional data files included with ShipEdit.  Each contains 8
  52.         different sets of graphics from Tyrian that can be used as ships.  To
  53.         use one of these files, simply rename it to be USER.SHP.
  54.  
  55. NEWSH$.SHP
  56.         This is the compiled data file which is used by Tyrian.  ShipEdit
  57.         automatically saves your data and compiles it when you exit the
  58.         program.  This file is version-specific!
  59.  
  60.  
  61. Giving Custom Ships to Other People:
  62.  
  63.      There are two ways to give data you have edited to other people.
  64.  
  65.      (1) Give them your editor data - USER.SHP.  If they have ShipEdit, they
  66.          can edit this file and compile it for use with their version of
  67.          Tyrian.  (To compile it, just run ShipEdit and then exit the program.)
  68.  
  69.          Note that if they enter the ship data editor, ShipEdit will change
  70.          the data presented if they do not have access to those weapons.
  71.          (See Below under the section SHIP DATA for more information.)
  72.  
  73.      (2) Give them your compiled data file NEWSH$.SHP.  This is
  74.          version-specific but they do not need ShipEdit to use it.  I would
  75.          suggest limiting uploads of this file to those compiled under version
  76.          1.2 to avoid future problems - or at least to clearly mark what
  77.          version you intend this for.  Versions 1.0 and 1.1 are interchangeable
  78.          but 1.2 uses a different format.
  79.  
  80. ┌─────────────────────────┐
  81. │ Using a NEWSH$.SHP file │     
  82. └─────────────────────────┘
  83.  
  84. Tyrian will automatically find a NEWSH$.SHP file, check for how much memory
  85. it requires, and load it into your game.
  86.  
  87. To activate one of the ten available ships while playing:
  88.  
  89. Player 1:  Hold down  TAB and press a number from 1 through 0    [0=Ship #10]
  90. Player 2:  Hold down CAPS and press a number from 1 through 0
  91.  
  92. NEWSH$.SHP contains the graphics for your custom ships.  If you change the
  93. graphics in this file, your saved games will use the new graphics.  Just make
  94. sure you don't delete this file after you've started using them.
  95.  
  96. For example, if I pressed TAB+5, I would activate my custom ship #5.  This
  97. might be using graphic set #3, which is a snowball.  If I changed the ship
  98. graphic to a bubble in the editor and then ran Tyrian again, this ship would
  99. no longer be a snowball, but would use the bubble graphics.
  100.  
  101. ┌─────────────────────────┐
  102. │ Ship Data               │
  103. └─────────────────────────┘
  104.  
  105. There are 10 fields for each ship.  There are 10 sets of ship data you can
  106. use at one time.
  107.  
  108. [NOTE: The Street-Fighter-Like commands (or "twiddles", as one person so oddly
  109. put it) will not work for custom ships that you design.  It's the price you
  110. pay, though I may alter it someday if I find an easy workaround.]
  111.  
  112.  
  113. SHIP #:        This is the ship slot you are currently editing.  At the bottom
  114.                of the screen you are shown how to activate this ship while
  115.                playing the game.
  116.  
  117. Ship Graphic:  This is the graphic your ship will use.  You may select from
  118.                just about any of the graphics available in the game, and can
  119.                choose from any of the eight custom sets of graphics.
  120.  
  121.                Choose the items this ship configuration will use:
  122. Front Weapon:    [*]
  123. Rear Weapon:     [*]
  124. Special Weapon:  [*]
  125. Left Sidekick:   [*]
  126. Right Sidekick:  [*]   [**]
  127. Power:          [***]
  128. Armor:          [***]
  129. Shield:         [***]
  130.  
  131. [*]  - The game will keep track of every weapon you have found.  Aside from a
  132.        basic available selection, you can only choose those weapons that you
  133.        have found.
  134.  
  135. [**] - There are cetain sidekicks available in Version 1.2 which should only
  136.        be used as RIGHT sidekicks.  They probably won't crash the game, but
  137.        if selected as a left sidekick will not look very nice.  These are
  138.        labeled in the editor as [RIGHT ONLY].
  139.  
  140. [***]- The more you play the game, the better the class of items you can
  141.        select.  Also, this will improve faster if you get good destruction
  142.        percentage scores.  Good luck!
  143.  
  144. ┌─────────────────────────┐
  145. │ Graphical Editor        │
  146. └─────────────────────────┘
  147.  
  148. As you can see by the example files, User1 and User2, there are 8 banks of
  149. ships which are labeled within the editor.  There are five turning frames
  150. for each ship, from left to right:
  151.  
  152. #1 - Hard left turn
  153. #2 - Beginning left turn
  154. #3 - Center
  155. #4 - Beginning right turn
  156. #5 - Hard right turn
  157.  
  158. You CAN use the available graphical tools, but they are keyboard-based and
  159. are cumbersome to use except for slight touch-ups or applying certain
  160. specific alterations.  The commands are shown onscreen in the help boxes if
  161. you need to use them.
  162.  
  163. I would suggest using an independent program to create your own PCX screens
  164. and to load in ships from there.  Keep in mind that you can use SHIPEDIT.PCX
  165. to get the palette you need to use, or you can simply capture the editor
  166. screen.
  167.  
  168. To capture a shape from a PCX screen, move to the ship frame you want to
  169. edit and press 'E'.  This will activate the editor for this shape.  Now, press
  170. 'E' again to bring up a list of PCX files in the current directory.
  171.  
  172. Select the PCX file to capture from by pressing the first letter of the
  173. image name and/or using the arrow keys.  Then, press ENTER.  [ESC will exit
  174. this screen.]
  175.  
  176. Now, the image will be displayed onscreen and a flashing rectangle will also
  177. appear.  Use your mouse to position the rectangle around the shape you want
  178. to capture and press button 1.  [ESC will also exit this screen.]
  179.  
  180. To capture another frame from the same file, all you need to do is move to the
  181. next frame you want to capture and press 'L'.
  182.  
  183. Keep in mind that Color #0 is transparent!  We don't want to have you flying
  184. around in a black rectangle, now, do we?
  185.  
  186. ┌─────────────────────────┐
  187. │ Music                   │
  188. └─────────────────────────┘
  189.  
  190. Yes, ShipEdit will load the Tyrian music data and attempt to play it.  It may
  191. or may not work with MIDI very well, but does use the same driver as Tyrian,
  192. so there should be no problems.
  193.  
  194. There is another Jukebox in this version, an earlier one we didn't release,
  195. which is quite insane and should definitely confound you.
  196.  
  197. The Jukebox manual follows:
  198.  
  199. ╒═════════════════════════╕  ┌┐
  200. │ Basic-User's Commands   ├┬─┘└┐
  201. └─────────────────────────┴┴───┘
  202.  
  203. The left and right arrow keys change the song selection on the jukebox front.
  204.  
  205. V - Toggles between Tempo and Volume control.  Tempo is blue.  Volume is yellow.
  206.  
  207. The up and down arrow keys, in addition to the PGDN and PGUP keys, control
  208. the tempo bars on the bottom left and right of the screen.  The higher it
  209. gets, the faster the song plays.
  210.  
  211.  
  212. F - Fades the tempo down to slow.
  213.  
  214. L - If you have individual DAT files you want to play, this will load them
  215.     from the disk directly.
  216.  
  217. R - Starts the song over from the beginning again.
  218.  
  219. T - Resets the tempo to normal.
  220.  
  221. ESC or Q - Quit the Jukebox
  222.  
  223.  
  224. ╒═════════════════════════╕   ┌┐
  225. │       Disclaimer        ├─┬─┘└┐
  226. └─────────────────────────┴─┴───┘
  227.  
  228. WARNING: Users with heart trouble, epilepsy, regular seizures, and no artistic
  229.          taste should use caution when viewing these weird "screen-saver-like"
  230.          effects.  We are not responsible for the effects of our work.  :-)
  231.  
  232.  
  233. ╒═════════════════════════╕    ┌┐
  234. │ Advanced POWER JUKEBOX! ├┬─┬─┘└┐
  235. └─────────────────────────┴┴─┴───┘
  236.  
  237. COMMAND  │    FUNCTION
  238. ─────────┴────────────────────────────────────────────────────────────────────
  239.  
  240.     B     Blanks the screen to color 0   (often referred to as black)
  241.  
  242.     C     Clears the palette to black
  243.  
  244.     D     Draws the palette in two horizontal bars at the top-left of the
  245.           screen
  246.  
  247.     I     Loads a PCX image from disk
  248.  
  249.     M     Turns off all filters, turns the song name and bars off, and
  250.           sets the program to Ultra-Speed
  251.  
  252.     P     Creates a dual-color palette
  253.           This palette will fade all 256 colors from one color to another,
  254.           making it look ugly most of the time.
  255.           Keep pressing P until you find two colors you like.
  256.  
  257.     S     Toggles the song name and tempo bars on and off
  258.           (You won't notice you have turned them off because they'll still
  259.            be on the screen from the last time they were drawn there!)
  260.  
  261.     U     Reverts to the main palette after you're tired of the palette you
  262.           generated using P
  263.  
  264.     Z     Toggle Ultra-Speed   (This deactivates the delay and the stars)
  265.  
  266.     F1    Randomizes the RED values in the palette
  267.     F2    Randomizes the GREEN values in the palette
  268.     F3    Randomizes the BLUE values in the palette
  269.           (Generally, you'll use these commands after pressing C)
  270.  
  271.  [ and ]  Certain commands below use a variable in the program to modify their
  272.           effect.  The left bracket decreases this effect and the right
  273.           bracket increases it.
  274.  
  275.  { and }  For a faster way to modify the variable above, use these instead
  276.  
  277.  
  278. ──────────────────────────────────────────────────────────────────────────────
  279.  
  280.    1-4    Different fade effects
  281.            1- Vertical+Horizontal fade
  282.            2- Horizontal fade
  283.            3- Vertical fade
  284.            4- Diagonal fade
  285.  
  286.     5     Ugly fuzzy-plasm grower
  287.            Causes a field of fuzz to grow out of whatever shapes are on the
  288.            screen
  289.            Looks like tree bark under a microscope changing at an impossible
  290.            speed
  291.  
  292.     6     Fuzz
  293.  
  294.     7     Random Fuzz
  295.  
  296.     8     Generic No-frills fuzz
  297.           (Creates absolutely no interesting patterns, guaranteed!)
  298.  
  299.     9     Wild slow fade towards the bottom-right with a neat lava effect
  300.           growing out of the background after a while.
  301.           This works best with a palette generated by P.
  302.  
  303.     0     Weird circle thing.
  304.           A large circle creates more and more ripples of itself while
  305.           shrinking.  If it shrinks enough, you get to see duplicates of
  306.           the circle coming onto the screen.  Of course, it doesn't work
  307.           quite the way it originally did, but hey, it's neat.
  308.  
  309. SHIFT-0   Diamond generator
  310.           Creates odd cross-hatching diamond patterns.  Not as good as my
  311.           Quiltmaster, but oh well.
  312.  
  313. SHIFT-9   Cross-hatching color cycler
  314.           This works best with P.  It causes a box in the center of the screen
  315.           to cycle along a palette very slowly while introducing a growing
  316.           amount of noise.  It's weird seeing the image in the box fading
  317.           away and then coming back again in another color.
  318.           It reminds me of a stained-glass window.
  319.  
  320. SHIFT-8   Water rippler
  321.           P produces a nice palette to look at this with.
  322.           The image has a water (or lava) effect placed in the background
  323.           while any shapes on the screen waver in a wild pattern much like
  324.           a real pool of water changes the image reflecting in it when you
  325.           cause the water to run in a river over little rocks.
  326.  
  327. SHIFT-7   Medium water waves
  328. SHIFT-6   Water waves in almost symmetry
  329. SHIFT-5   Large water waves
  330. SHIFT-4   This one causes shapes on the screen to expand.
  331.           Once the shape expands enough, water waves appear inside it while
  332.           the shape still grows.
  333.           (The water wave effects work best with P or another nice palette
  334.            with few color transitions)
  335.  
  336. SHIFT-3   Super 9.
  337.           This one fades the screen constantly in a diagonal pattern, and
  338.           like 9, little dots appear in sections that have faded completely.
  339.           However, the dots cause circular ripples to appear overlapping
  340.           each other.  With a little user fiddling, the effect is fantastic.
  341.  
  342. SHIFT-2   This one causes a normal fade to work on the screen.
  343.           Like 9 and Shift-3, though, little dots can appear on the screen
  344.           as well.
  345.           But, you can control the dots using the left and right brackets
  346.           ( [ and ] ).  The left bracket decreases the rate of dot appearance
  347.           while the right bracket increases the rate.
  348.           The jukebox starts out with the bracket value at 0, meaning there
  349.           are NO dots that appear.
  350.  
  351.  
  352.           SUPER-PARALLAXING EFFECTS:
  353.  
  354.    -      Moderately fast parallax to the right
  355.    _      Moderately fast parallax to the left
  356.  
  357.    =      Slightly faster parallax to the right
  358.    +      Slightly faster parallax to the left
  359.  
  360.    ,      Fast, symmetric parallax to the left
  361.    .      Fast, symmetric parallax to the right
  362.  
  363.    <      Fast, symmetric parallax to the left    *with distortion*
  364.    >      Fast, symmetric parallax to the right   *with distortion*
  365.  
  366.    ;      Very Fast, symmetric parallax to the left
  367.    '      Very Fast, symmetric parallax to the right
  368.  
  369.    The Super-Parallaxing effects all function like SHIFT-2 except for
  370.    [<] and [>] which function like SHIFT-3.
  371.  
  372.    The [-] and [_] commands cannot be combined with other commands, while
  373.    all the other parallax commands can.
  374.  
  375. SHIFT-1   This function uses the brackets the same way as SHIFT-2.
  376.           However, it parallaxes both left and right at the same time with
  377.           the center standing still!  This is centered perfectly on the
  378.           center of the ECLIPSE logo in ECLIPSE2.PCX.
  379.  
  380.    F5     Auto-Detailer.
  381.           This effect creates weird details in pictures and generally works
  382.           best on a pre-made image with a well-gradiated palette.
  383.  
  384.  F6-F8    More Auto-Detailer modes!
  385.  
  386. SHIFT-F5  Even MORE Auto-Detailer modes!
  387.  through  (SHIFT-F8 is my favorite)
  388.  SHIFT-F8
  389.  
  390. BACKSPACE Screen-Streaker
  391.           Causes any image on the screen to fade (or slide) downwards.  This
  392.           often leaves large amounts of residue at the top.
  393.  
  394. ──────────────────────────────────────────────────────────────────────────────
  395.  
  396.  
  397. ╒═════════════════════════╕    ┌┐
  398. │  Suggested User Tests   ├┬─┬─┘└┐
  399. └─────────────────────────┴┴─┴───┘
  400.  
  401. The Blurry Amoeboid:
  402.  
  403.    [P]  Keep pressing P until you find a nice palette with a lot of contrast.
  404.  
  405.    [9]  This will start the Wild Neon Lava Fade
  406.  
  407.    [6]  This will create a semi-interesting pattern
  408.  
  409.    [5]  This completes the Amoeboid pattern
  410.  
  411. ──────────────────────────────────────────────────────────────────────────────
  412.  
  413. The Diagonal Pattern-Maker:
  414.  
  415.    [P]  Keep pressing P until you find a nice palette with a lot of contrast
  416.  
  417.    [0]  Start the Circle thing
  418.  
  419.    [5]  This completes the Diagonal Pattern-Maker
  420.  
  421. ?[7or9] Adding 7 or 9 causes the Pattern-Maker to behave differently
  422.  
  423. Note:
  424.   By adding SHIFT-5, SHIFT-6, and/or SHIFT-7 to the Pattern-Maker you turn
  425.   it into a really interesting effect.  You have to see it to understand it.
  426.  
  427. ──────────────────────────────────────────────────────────────────────────────
  428.  
  429. ┌─────────────────────────┐
  430. │ Disclaimer              │
  431. └─────────────────────────┘
  432.  
  433. ShipEdit is written by the same person who wrote Tyrian [and this manual],
  434. but it is not supported by XSIV Games and is regarded as an independent
  435. creation.  It is not specifically supported in any way by anyone, though nice
  436. letters to me on the Internet might get you an answer. :)
  437.  
  438. I forsee no problems as long as you keep in mind the version limitations.
  439. For instance, additional items available in version 1.2 will probably crash
  440. someone's copy of version 1.1, so try to indicate what version you intend any
  441. uploads to be used under!
  442.  
  443. As always, with something as complex as this, there are probably bugs and other
  444. problems.  I've never seen one, but who knows?
  445.  
  446. -Zinglon-
  447. -Master of All-
  448.  
  449. ...and...
  450.  
  451. -Jason Emery-
  452. - The Author-