use.txt

支持网络和单机的麻将游戏

    anything. When reconnecting to an existing game, if the ID is given as 
    0, the server will try to use the "Name" to identify the player. (This
    may not be true in future.) The "Name" field is remembered from game
    to game.

The "Join server..." dialog then simply has a "Connect" button
to establish the connection. The "New local game..." has the following
fields:

  For each of three further players,
    A checkbox to say whether to start a computer player. (Some of) these
    should be unchecked if you wish other humans to join the games.
    If checked, there is a text entry to set the players' names, and a
    text entry field in which options can be given to the players; the
    latter should only be used if you understand the options! 

  An "allow disconnection" checkbox
    If this is checked, the server that is started will continue to run
    even if players disconnect. If it is not checked, the server will quit 
    if any player disconnects. If you are playing one against the
    computer, this should generally be left unchecked, in order to avoid
    server processes accidentally being left lying around. If playing
    against people, it should be checked, to allow players to go away, or
    to guard against network outages.

  As "save game state on exit" checkbox
    If this is checked, the server will save the game state (see below on
    on saving and resuming games) when a player disconnects and causes it
    to quit.

  A "seat players randomly" checkbox
    If this is left unchecked, players will be initially seated as East,
    South, West, North in order of connection. (We always connect first.)
    If it is checked, the seating will be random.

  A numeric entry field
    to specify the time limit for claiming discards.
    If set to 0, there will be no time limit.

  A button to start the game
    Note that it takes a few seconds to start a game, during which time
    the dialog stays up with the button pressed. (TODO: fix this!)
    
Saving and resuming games
-------------------------
At any time during the play of a game, you can choose the "Save" entry
from the "Game" menu. This causes the server to save the current state
of the game in a file. The file will be named  game- DATE .mjs  by
default; if a name has previously been specified, or if the game was
resumed from a file, that name will be used. To specify a name, use
the "Save as..." entry in the "Game" menu. Note that for security,
directories cannot be specified (except by resuming a game), so the
file will be created in the working directory of the server.

To resume a saved game, use the "Resume game..." entry from the "Game"
menu. This is just like the "New local game..." panel, but it has a box to
specify the file containing the saved game. At present, you must type
the name of the file into this box. TODO find a file selector widget
for this.

Setting display and game options
--------------------------------
The "Options" menu of  xmj  brings up panels to set various
options related to the display and to the game rules.
Most of these options can be stored in the preferences file,
which is  .xmjrc  in your home directory on Unix, and  xmj.ini 
in your home (whatever that means) directory on Microsoft Windows.

Display Options
---------------
This panel controls options related to the local display.
At the bottom are three buttons: "Save & Apply" applies changes and
saves them in the preferences file for future sessions; "Apply (no
save)" applies any changes, but does not save them; "Cancel" ignores changes.
Note that many display options can also be controlled by command-line
arguments; if an option is specified both in the preferences file and
on the command line, the command line takes priority.

  Position of action dialogs.
    This determines where the dialogs for user actions in the game are
    popped up; see the description of the  --dialogs-central  etc.
    options above. This option is stored in the preferences file as
    Display DialogPosition POSN
    where POSN is one of "central", "below" or "popup".

  Animation
    determines whether tile movements are animated (see the  --animate 
    option above). This option is stored in the preferences file as
    Display Animate BOOL
    where BOOL is "0" or "1".

  Display status and messages in main window
    puts the game status and message (chat) windows in the main window,
    above the table, instead of having separate popup windows. This option
    is stored in the preferences file as 
    Display InfoInMain BOOL
    where BOOL is "0" or "1".

  Don't popup scoring/message windows
    will prevent the automatic popup of the scoring window at the end of
    a hand, the message window on the arrival of a message, and the game
    status window at the end of the game. This option is stored in the preferences file as
    Display NoPopups BOOL
    where BOOL is "0" or "1".

  Tiletips always shown
    means that the name of a tile is displayed whenever the mouse enters
    it, and the name of the selected tile is always shown. (Otherwise,
    right-click to display the name.) This option is stored in the
    preferences file as
    Display Tiletips BOOL
    where BOOL is "0" or "1".

  Display size
    This drop-down list specifies the size of the display. The size should
    be thought of as the length of a tile rack. This is only relevant if
    the wall is not being displayed. Values range from 14 to 19; if
    "(auto)" (the default) is specified, the client tries to choose a size
    as big as will fit in the display. This option can also be specified
    by the command line  --size  argument. This option is stored in the
    preferences file as 
    Display Size N

  Show the wall
    "always" is equivalent to the  --show-wall  option; "never" is
    equivalent to the  --no-show-wall  option; and "when room" is the
    default. This option is stored in the preferences file as
    Display ShowWall WHEN
    where WHEN is one of "always", "when-room" or "never".

  Iconify all windows with main
    If this option is set (the default), then when the main xmj window is
    iconified, (almost) all other open windows such as dialogs will also
    be iconified; when the main window is uniconified, the other windows
    will also be uniconified. If it is not set, all windows are
    independent of one another. This option is stored in the preferences file as 
    Display IconifyDialogs BOOL
    This option is not currently supported under Microsoft Windows.

  Tileset
    this is the tile pixmap directory, also given by the  --tileset 
    option. This option is stored in the preferences file as
    Display Tileset DIRNAME

  Tileset Path
    this is the search path for tileset directories, also given by the
    --tileset-path  option. This option is stored in the preferences
    file as 
    Display TilesetPath SEARCH-PATH

  Main font selection...
    This button brings up a font selection dialog to choose the font
    used in buttons, menus, etc. in the client. This option is stored in
    the preferences file as 
    Display MainFont LFD
    where LFD is an X logical font descriptor as used by GTK.

  Text font selection...
    This button brings up a font selection dialog to choose the font
    used in text display (such as scoring info and chat) in the
    client. This option is stored in the preferences file as 
    Display TextFont LFD
    where LFD is an X logical font descriptor as used by GTK.

  Table colour selection...
    Unaccountably, not everybody likes my choice of dark green for the
    table background. This button brings up a colour selection box to
    allow the table colour to be changed.This option is stored in the
    preferences file as  
    Display TableColour COL
    where COL is a valid X colour specification, typically 
    rgb:RRRR/GGGG/BBBB where RRRR etc are four digit hex values for red,
    green and blue.
    
Playing Preferences
-------------------
This panel controls what actions the client may take on your behalf.
The first (and currently only) section specifies when the client
should declare tiles and sets for you. It has the following checkboxes:

  flowers and seasons
    if checked, will be automatically declared as soon as drawn.

  losing hands
    if this is checked, then when somebody else goes out, the client will
    declare your closed sets. It declares in the order pungs, pairs,
    chows.

  winning hands
    this is the same for when you go out.

The panel has "Save & Apply", "Apply (no save)" and "Cancel" buttons,
as in the display options panel.

Game Option Preferences
-----------------------
This panel controls preferred game options which will be sent to the
server when a game starts. Preferences will only be applied if we are
the game manager, or the game has no manager. (Normally, the first
human player to connect to the server becomes the game manager.)
For details of options and their meanings, see the Game Options
section in the rules.
The panel has two action buttons, "Save Changes" and "Cancel", with
the obvious meanings. Note if a game is in progress, changed
preferences are NOT applied to it; however, there is a button
in the Current Game Options panel to apply preferences.
The main body of the panel is a scrollable window listing all the
known options. If no preference is stored for the FooBar option,
then there is an "Add pref" button next to a description of the FooBar 
option. If this button is clicked, an entry for setting the option
appears. The format of this entry depends on the type of the option
(see the Game Options section of the rules for details of types):

  Boolean (on/off) options
    have a checkbox.

  Integer options
    have a spinbutton for numerical entry: the value can be typed in, or
    the up and down arrows can be used to change it

  Score options
    have radio buttons for selecting Limit, Half-Limit, or other; for
    other, the number of doubles and/or points is entered with
    spinbuttons. (Note: the underlying protocol allows percentages
    (possibly more than 100%) of limits to be specified for scores;
    however, the current graphical interfaces allow only limits or
    half-limits. Even half-limits are pretty strange, but some bizarre
    sets of rules, such as those of the British Mah-Jong Association
    (which plays a weird American/Western/Chinese mix), allow other
    fractions of limits.)

  String options
    have a simple text entry field.

All option entries have a "Reset" button which returns the entry to
its previous state.
A preference is removed by clicking the "Remove pref" button.

Current Game Options
--------------------
When there is a connected game, this panel allows its game options to
be modified (if we have permission to do so). The three action buttons 
are "Apply changes", which applies the panel's settings to the current 
game; "Apply prefs", which applies our preferences (as described
above) to the current game; and "Cancel".
The body of the panel contains entries for all the options of the
current game, in the same format as the preferences panel (see above).


UPDATES
-------
The latest release of the Unix Mah-Jong programs should be available at
http://www.stevens-bradfield.com/MahJong/ 
http://www.dcs.ed.ac.uk/home/jcb/MahJong/