Changeset 882 for trunk/faq.txt

Show
Ignore:
Timestamp:
05/06/08 17:36:48 (4 months ago)
Author:
takkaria
Message:

Commit a slightly better FAQ that I've had hanging around for a while.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/faq.txt

    r295 r882  
    1 A brief Angband FAQ 
    2 =================== 
     1The Angband FAQ 
    32 
    4 1. "I want old school #s as wall tiles, not solid blocks!" 
    5    "There are no walls, and I'm playing on Windows Vista." 
     3Posted every other month on rec.games.roguelike.angband and kept up-to-date on the forum [http://angband.oook.cz/forum]. 
    64 
    7    Please see: 
    8      http://angband.oook.cz/forum/showthread.php?t=88 and 
    9      http://angband.oook.cz/forum/showthread.php?t=26 
     51. Issues and problems 
     6        a. How do I report a bug? 
     7        b. I hate the store interface! 
     8        c. Dark monsters are hard to see. 
     9        d. I want old-school '#'s as wall tiles, not solid blocks! 
     10        e. I use Vista and my display is messed up. 
     11        e. I play in the console on Linux, and the colours are screwed up. 
     12        f. I'm playing in a terminal and the Escape key isn't working as it should - I have to press it twice, or just wait a while. 
     13        g. Is there a way to disable that thing that pops up when you hit the enter key? 
    1014 
    11 2. "How do I get hold of the David Gervais 32x32 tiles?" 
     152. Development 
     16        a. What are the current plans for the game? 
     17        b. How do I suggesting an idea/feature? 
     18        c. How do I get a copy of the source code? 
     19        c. How do I compile the game? 
     20        d. How do I contribute to the game? 
    1221 
    13    If you're on Windows or using the X11 port, you'll have to download 
    14    them from the below URL and place the files in your lib/xtra directory. 
     22----------------------------------------------------------------- 
    1523 
    16    http://angband.oook.cz/download/extra/graf-32x32-306.zip 
     241a. How do I report a bug? 
    1725 
    18 3. "I play in the console on Linux, and the colours are screwed up" 
     26First of all, use http://dev.rephial.org/trac/search?ticket=on to see if your bug has been reported.  Try using a key word or two (like "recall" for monster recall, "pseudo" for pseudo-ID). 
    1927 
    20    Please see: 
    21      http://angband.oook.cz/forum/showthread.php?t=77 
     28If you can't find it there, you're best off posting on the forum or the newsgroup; if it's been reported (several) already, you will get replies sounding more annoyed as the number of times it's been previously reported goes up, but so life goes. 
    2229 
    23 4. "I'm playing in a terminal and the Escape key isn't working as it 
    24    should - I have to press it twice, or just wait a while." 
     30Bug reports should *always* include your current operating system (e.g. Windows XP), what version the problem appeared in, and the best steps you can figure out to reproduce the bug.  Savefiles that show the problem might be requested, because they help tracking bugs down. 
    2531 
    26    This is a feature of terminals to allow you to enter keypresses that 
    27    can't be sent directly.  Use the backtick ('`') key instead -- it's 
    28    equivalent in every way to Escape. 
     321b. I hate the store interface! 
     33 
     34Sorry, but it's staying that way for now.  Expect a better one  
     35 
     361c. Dark monsters are hard to see. 
     37 
     38Fix (reduce) the alpha on your screen, or use the "Interact with colors" screen under the options ('=') menu.  (On older versions, use the '&' command.)  Navigate to the '8' using 'n' and increase the color intensity with r(ed)g(reen)b(lue). 
     39 
     401d. I want old-school '#'s as wall tiles, not solid blocks! 
     411e. I use Vista and my display is messed up. 
     42 
     43Please see http://angband.oook.cz/forum/showthread.php?t=88 and http://angband.oook.cz/forum/showthread.php?t=26 
     44 
     451e. I play in the console on Linux, and the colours are screwed up. 
     46 
     47Please see http://angband.oook.cz/forum/showthread.php?t=77 
     48 
     491f. I'm playing in a terminal and the Escape key isn't working as it should - I have to press it twice, or just wait a while. 
     50 
     51This is a feature of terminals to allow you to enter keypresses that can't be sent directly.  Use the backtick '`' key instead - it's equivalent in every way to Escape.  (This doesn't apply in Sangband, or NPPAngband.) 
     52 
     531g. Is there a way to disable that thing that pops up when you hit the enter key? 
     54 
     55Go into the options menu, choose "Interact with macros", then "Create a keymap".  Press Enter at the "Keypress" prompt and a single space as the "Action".  In short: `=m8<enter> <enter>` 
     56 
     57And then you'll probably want to choose to "Append keymaps to a file" so that it persists for next time you load the game. 
     58 
     59This just replaces the default action of Enter with a "do nothing but don't tell me about help" action.  If you want to keep the menu available, say on the 'Tab' key, you can also remap the Tab keypress to the '\n' action. 
     60 
     61----------------------------------------------------------------- 
     62 
     632a. What are the current plans for the game? 
     64 
     65Ever-changing and subject to U-turning with public dissent. 
     66 
     672b. How do I suggest an idea/feature? 
     68 
     69Post it on the newsgroup or the forums.  If people think it's a good idea, it will generally get some discussion; if they don't, it won't.  The developers keep an eye on r.g.r.a and the forums, and ideas deemed OK will get filed for future implementation. 
     70 
     71Sometimes a suggestion may not be right for the game, thougn. Some suggestions would change aspects of Angband that are essential to its nature; Angband has a long history, and so has developed a certain character over the years.  Some suggestions might make a good game, perhaps even a better game than Angband, but would make a game that is not Angband.  To some extent, variants exist to address this, but even so they tend to adhere to the core Angband principles.  
     72 
     732c. How do I get a copy of the source code? 
     74 
     75It depends what you want it for.  If you want to start a new variant, you may want to start with the last stable release of the game (maybe 3.0.9, for example).  If you're more interested in hacking on Vanilla Angband, then you really want to get hold of the latest development version.  Luckily, both are easy. 
     76 
     77The latest version's source is linked to from the page http://rephial.org/. 
     78 
     79To get the SVN trunk, get Subversion [http://subversion.tigris.org/] for your system, and checkout the repository "http://dev.rephial.org/svn/trunk/".  On the commandline, this would be done like so: "svn co http://dev.rephial.org/".  You'd do well to read a Subversion primer, too. 
     80 
     812c. How do I compile the game? 
     82 
     83Please see http://rephial.org/wiki/Compiling for an up-to-date guide to this. 
     84 
     852d. How do I contribute to the game? 
     86 
     87First, join the mailing list [http://angband.oook.cz/mailman/listinfo/angband-dev]. 
     88 
     89If you already have a patch you want to be included, please send it to the mailing list in the form of a unified diff against either the SVN trunk (e.g. using svn diff) or the latest public release.  Please be careful to follow the Angband coding guidelines [http://rephial.org/wiki/CodingGuidelines].  All contributions to individual files are accepted under the licences used in the file header.  Make sure you're OK with this before sending in patches. 
     90 
     91If the patch is a bugfix, then you can reasonably expect it to be integrated into the development tree. If it's more involved, and the feature is not one that the next version is planned to have, the patch may go through several reviews before being incorporated. It may also just be unsuitable for Angband—in which case, please don't take rejection badly; you may just be better off writing a variant. 
     92 
     93Non-code activites are different. Documentation can be written on the wiki, or if you're a graphics designer (and they're always welcome) then please talk on the mailing list about your work. 
     94