home *** CD-ROM | disk | FTP | other *** search
/ ftp.lokigames.com / ftp.lokigames.com.zip / ftp.lokigames.com / extras / heroes3 / README.txt < prev   
Text File  |  2000-10-27  |  14KB  |  310 lines

  1. Thank you for trying out the Heroes of Might and Magic III map editor for
  2.  Linux!
  3.  
  4.  
  5. SYSTEM REQUIREMENTS:
  6.  
  7. - Linux 2.2.x is preferrable. May run on others.
  8. - glibc 2.1 is preferrable. May run on others.
  9. - XFree86 3.3.x is preferrable. May run on others.
  10. - Your X-server MUST be at either 16-bit or 32-bit color depth. The program
  11.   gives a polite error and aborts, otherwise. The 32-bit color support is
  12.   currently a hack, so expect it to run MUCH slower than in 16-bit mode.
  13. - The more RAM, the better, but this should run in a system with 64 megs, and
  14.    probably even less.
  15.  
  16. Reports of success and failure with unexpected systems (8 megs of RAM, FreeBSD,
  17.  etc.) are welcome at icculus@lokigames.com.
  18.  
  19.  
  20. TO INSTALL:
  21.  
  22. - Install Heroes3 on your system.  You NEED to have the game installed to use
  23.   the editor, since the editor makes extensive use of the game's data files.
  24.   If you need a copy of the game, it can be purchased from
  25.   http://www.lokigames.com/ and anywhere else where fine Linux games are sold.
  26.   If worse comes to worse, the Heroes3 demo can be used as well, but you will
  27.   not be able to PLAY the maps you make in the demo, and that's just no fun,
  28.   now is it?
  29.  
  30. - Untar the editor's archive (if you're reading this, you probably already
  31.   have.)... i.e. tar -xzvvf /my/download/directory/h3maped-1.0-i686.tar.gz
  32.  
  33. - Now just run the editor from within its directory:
  34.  
  35.     cd /home/icculus/h3maped
  36.     ./h3maped
  37.  
  38. - If you don't have Heroes3 (or the demo) installed in
  39.     /usr/local/games/Heroes3, you will be prompted to enter the correct
  40.     directory the first time you run the editor. Unless you (re)move the
  41.     contents of the directory you specify, the program won't prompt you to
  42.     enter this information again.
  43.  
  44. KNOWN BUGS:
  45.   Lots.  :)   Most notably, the Map Specifications and Hero Properties dialogs
  46.   are somewhat unstable.
  47.  
  48.   - The rulers on the main map area don't scale correctly when not using the
  49.     default zoom setting. The editor is still functional, it's just a little
  50.     less helpful.
  51.  
  52.   - Check marks for specialized objects don't draw. To remind the programmer
  53.     of this fact, stderr is flooded with the text:
  54.  
  55.       ** WARNING **: NO CHECK MARK.
  56.  
  57.   Please save early, and save often.
  58.  
  59.  
  60. FAQs:
  61.  
  62.   Q: How do I report bugs?
  63.   A: If the program crashed, get a backtrace.
  64.  
  65.        gdb ./h3maped
  66.        (after gdb loads, type:) run
  67.        (make the editor crash. then, in gdb window, type:) bt
  68.  
  69.      Send all that gobbeldegook off to us (read below). It helps immensely.
  70.  
  71.      If the program didn't crash, but just behaved incorrectly, then skip the
  72.      backtrace step. Gather all the pertinent details (what you were doing,
  73.      etc), and send it off to us. If you can tell us PRECISELY how to reproduce
  74.      it, that's even better. It also helps to tell us whatever you can think
  75.      of that's pertinent: what Linux distribution/version, GTK+ theme you're
  76.      using for graphical problems, X server/version, etc... There is NO such
  77.      thing as too much information.
  78.  
  79.      Once you've got all the details that seem important, here's how to
  80.      send it to us: Point your web browser at http://fenris.lokigames.com/,
  81.      where you can input all the information pertinent to your special bug.
  82.      Fenris also allows other people to see what bugs have been reported, and
  83.      gives us a centralized way to report them fixed. Do NOT email me directly
  84.      about bugs, as Fenris will automail me any bug reports for the editor!
  85.  
  86.      It's also a good to see if your bug has already been reported in Fenris.
  87.      We fix all the bugs, not just the popular ones, so unless you're problem
  88.      is new or different than an existing bug, don't bother reporting it.
  89.  
  90.      That said, non-bug related questions can go to icculus@lokigames.com, or
  91.      for community-related talk,
  92.  
  93.         news://news.lokigames.com/loki.games.heroes3
  94.  
  95.   Q: Can I use my maps from the win32 mapeditor with the Linux editor?
  96.   A:  Yes. And vice-versa.
  97.  
  98.   Q: Can I run maps I make under Linux on the Windows version of the game?
  99.   A:  Yes. And vice versa.
  100.  
  101.   Q: Can I edit the standard game maps?
  102.   A:  Yes. They are in /yourheroes3directory/maps. Doing so can alter gameplay
  103.       rather drastically, so you might want to make a backup of this directory
  104.       before you start to explore. Also, there are probably copyright issues
  105.       with distributing a modified version of the standard maps, so it is
  106.       probably best to start from scratch when you get a creative urge. Oh,
  107.       and if you want to look around the game maps to aid in gameplay, you're
  108.       a dirty cheater. :)
  109.  
  110.   Q: I can't find the standard campaign maps to edit!
  111.   A:  I think these are buried in a data file. Perhaps in the future there'll
  112.       be a means to extract them for editing, but not right now. The ones in
  113.       the Heroes3 maps directory are all single-play maps.
  114.  
  115.   Q: How about some map editing tips?
  116.   A: Draw land. Put some items on it.  :)  Be sure to put some heroes (look
  117.      for the armor helmet on the toolbar) and some towns (look for the castle)
  118.      on the map for each player. Current player you are laying towns and
  119.      heroes for can be changed with the "Player" menu, or by hitting CTRL-1
  120.      for player 1, CTRL-2 for player 2, etc. Once you've got some coherence
  121.      to your map, use the Map Validation option on the Tools menu (SHIFT-V on
  122.      the keyboard.) This will give you more pointers on what is needed for
  123.      a "correct", playable map. By default, all maps have two layers: an above
  124.      ground layer, and an underground. Certain objects in the palette let you
  125.      teleport between these, but effectively you've got two maps for the price
  126.      of one!  The map can be made single-layer (just an overworld), by
  127.      changing the "Two level map" check mark on the Map Specifications
  128.      general page. Certain objects (heroes, signs, some buildings) have special
  129.      properties. Select the object, and then click the "properties" item on the
  130.      Edit menu to modify these details.
  131.  
  132.   Q: Hey, I made a map and it doesn't show up in the game!  What gives?
  133.   A: First, did you copy it into the "maps" directory under the Heroes3
  134.       game directory? You will probably need to be root to copy it, but your
  135.       permissions to play the map are the same as playing the regular game.
  136.       Secondly, did you run Map Validation on your creation?  It will remind
  137.       you to NAME YOUR MAP. If you don't do this, it comes up in the Heroes3
  138.       map list as "UNNAMED". Not only is this bad, but Heroes3 also places
  139.       unnamed maps at the top of the list, and positions the scroll bar so you
  140.       have to slide UP to see them. Just name the map under the General
  141.       notebook page in the Map Specifications dialog (menu: tools/Map
  142.       Specifications, or keyboard: CTRL-RETURN).
  143.  
  144.   Q: Hey, the editor is complaining that it's expired! Huh?
  145.   A: You have a beta release, and it is now too old. Come back to...
  146.          http://www.lokigames.com/
  147.       ...and get the latest release. It's free. As in beer.
  148.  
  149.   Q: What's up with the license?
  150.   A: Typos and flames about the licensing of this program may be taken up with
  151.       info@lokigames.com. The developers do not write the licenses. We don't
  152.       even READ them. We don't care about them. We certainly don't like flame
  153.       mail about them.
  154.  
  155.  
  156. SPECIAL THANKS:
  157.  - Andy Mecham, Pimptronic QA fiend.
  158.  - Mike Phillips, Support Gladiator.
  159.  - Rob Spidle, for being a l33t hax0r.
  160.  - jeffk.
  161.  
  162. Enjoy the map editor!
  163.  
  164. --ryan. (icculus@lokigames.com)
  165.  
  166.  
  167.  
  168. CHANGES:
  169.  
  170. 1.0: Saturday, September 23rd.
  171.  
  172. - Took out the beta expiration. This means that everything works perfectly,
  173. and if it doesn't, you probably have bad RAM in your machine. (uh, yeah.)
  174.  
  175.  
  176.  
  177. beta5: Monday, July 31th.
  178. (Please note that the newly added dialogs have not been tested very 
  179. extensively, so expect them to not be completely stable, or necessarily
  180. even usable. Also, the Seer's Hut properties dialog is not enabled
  181. yet, so there's a lot of complaints about missing functions when you
  182. start the program. This shouldn't prevent average use of the program,
  183. and will be fixed in the next release. Hey, that's why they call this a 
  184. beta.)
  185.  
  186. - Customizing a hero's troops no longer causes the program to abort. 
  187. - Previously, due to incorrectly hooked up signals, the hero's secondary
  188. skills and artifacts were not customizable. Fixed.
  189. - Added Town Properties dialog.
  190. - Added Artifact Properties dialog.
  191. - Added Edit Town Event dialog.
  192. - Edit Rumor dialog under Map Specifications Rumors tab was not popping
  193. up in some circumstances. Fixed.
  194. - All sorts of combo boxes were user-editable, which caused internal
  195. confusion in the editor. Now they may only be modified through their
  196. drop-down lists.
  197. - A bunch of modal dialogs didn't handle delete_events, so closing them
  198. from the window manager's titlebar would confuse the application. Fixed.
  199. - Updated to the most recent libglade (statically linked), since the
  200. previous version started segfaulting due to the size of the .glade file.
  201. - Lots of retardedness from the earlier parts of the work (before I was a
  202. big, bad, MFC-to-GTK porting machine) was cleaned up. There's still a lot
  203. of this to do, but it shouldn't affect the external appearance of the
  204. program.
  205. - The program will no longer set symbolic links. Now, the editor will
  206. search your PATH for the installed copy of HOMM3 to get the needed data
  207. files. If it can't find the data files, it prompts the user for the
  208. location of the HOMM3 installation, and attempts to recover.
  209. - A thousand other tiny bug fixes, all important, but WAY too numerous to list.
  210.  
  211.  
  212. beta4: Friday, June 16th.
  213. (The "What? It expired TODAY?!" release.)
  214.  
  215. - Several people reported an assertion failure due to a check in the
  216. object palette OnSize method. The object palette needed to be exactly 198
  217. pixels wide and at least 302 pixel high or the game would segfault in the
  218. paint code. This was a "feature" of the win32 code, which had more control
  219. over widget size. And while GTK+ takes my request to "MAKE THIS WIDGET
  220. EXACTLY THIS SIZE" seriously sometimes, some people had less luck than us
  221. and had GTK+ bump the palette's size by a pixel or two depending on theme,
  222. version, etc... The solution, of course, was to rewrite the paint code to
  223. be less moronic. Now, the code expects that those dimensions will be more
  224. or less satisfied, but won't segfault or assert in cases where they aren't.
  225.  
  226. - Hero's properties/Identity did not match the picture and name. Fixed.
  227.  
  228. - Our esteemed Mr. Phillips hacked in 32-bit color support.
  229.  
  230. - Updated the ever-ticking beta expiration.
  231.  
  232.  
  233.  
  234.  
  235. beta3: Wednesday, May 17th.
  236. (The "It's been a long time...we shouldn't've left you
  237.    without a dope beat to step to" release.)
  238.  
  239. - Program now automatically manages your symbolic links. More user-friendly.
  240.  
  241. - Cut, copy, paste, redo, and undo now have the expected keyboard
  242. accelerators.
  243.  
  244. - ./h3maped --help now prints a simple message to stderr and exits.
  245.  
  246. - Message boxes' OK button now regrabs the keyboard focus, so you can
  247. just smack the spacebar to continue when one comes up.
  248.  
  249. - There's now a nice text readout under the object palette that tells you
  250. what your pointer is hovering over. This is MAJORLY helpful.
  251.  
  252. - Arrow keys can move map around, as can the mouse wheel.
  253.  
  254. - Updated the beta expiration date.  (*shrug*)  Sorry 'bout that.
  255.  
  256.  
  257.  
  258. beta2: Friday, April 7th, 2000.  (hhm...that's not right!)
  259.  
  260.  - Fixed the problem that some people were having with not being able to
  261.    start the program. The dialog that complains about 16-bit color depths was
  262.    causing a dialog from the .glade file to be shown before the .glade file
  263.    was read. Whoops. You still need to be in 16-bit color mode to actually
  264.    USE the program, but at least it politely informs you of this fact, now.
  265.  
  266.  - Clicking on something off the mapeditwnd when dragging an obj used to
  267.    cause the object to drop on the edge of the view where it happened to be
  268.    sitting. Now it discards it. This seems to be preferrable, especially for
  269.    new objects. If that oak tree had a lot of meaning to you, though, you're
  270.    just going to have to come to terms with the fact that its bits have been
  271.    recycled into the cosmic consciousness.
  272.  
  273.  - Furthermore, when dragging an object, the right mouse button immediately
  274.    discards it, so you don't have to drop it and then use the "delete"
  275.    menuitem.
  276.  
  277.  - Beta notice dialog box comes up during splash screen, now. Before the
  278.    entire editor would load before the notice, which would be really annoying
  279.    once the beta expires!.
  280.  
  281.  - Animation menu option has been added, which, at the cost of more
  282.    processing, makes the editing process much more lively. It may be
  283.    (de)activated from the "View" menu, or with CTRL-A. Try it. It's fun.
  284.  
  285.  - Much like Civ:CTP, you can now scroll around the mapeditwnd with the
  286.    middle mouse button.
  287.  
  288.  - Cut, Copy, and Paste are now functional, and have been added back to the
  289.    Edit menu.
  290.  
  291.  - The "ok msgbox" now puts the default focus on the button, so you can
  292.    just smack the spacebar instead of clicking around.
  293.  
  294.  - You are now prompted before overwriting an existing map file.
  295.  
  296.  - Object properties can now be edited. This code is still very unstable,
  297.    so be sure to save before modifying properties.
  298.  
  299.  - Other assertion failures and segfaults fixed.
  300.  
  301.  
  302.  
  303. beta1: Friday, April 7th, 2000.
  304.  
  305.  - First public release.
  306.  
  307.  
  308. // end of README.beta ...
  309.  
  310.