
-------------------------------------------------------------------------

 XXXX   XXX   XXX  X   X XXXX  X   XXX      XXXXX   X   X    XXXX Client
 X   X X   X X   X X   X X     X  X   X     X X X  X X  X    X
 X   X X   X X     X   X X        X           X    X X  X    X
 XXXX  X   X X     X   X XXX       XXX        X   X   X X    XXX
 X  X  X   X X XXX X   X X            X       X   XXXXX X    X
 X   X X   X X   X X   X X        X   X       X   X   X X    X
 X   X  XXX   XXX   XXX  XXXX      XXX        X   X   X XXXX XXXX (v1.06)

-------------------------------------------------------------------------

Detailed game system and rules can be found at http://rogue.epixx.org

In-game help can be viewed with /? and /help chat commands.



Command line parameters:
-------------------------------------------------------------------------

The game starts in a frameless window that takes up all the space on the
main screen by default. You can use command line parameters to adjust the
size and other variables to your liking.

  -x 100                Sets the window's initial x location to 100.
  -y 100                Sets the window's initial y location to 100.
  -w 960                Sets the window's initial width to 960 pixels.
  -h 600                Sets the window's initial height to 600 pixels.

  -fs                   Sets the window frameless, meaning it has no
                        title bar or borders.

  -user username        Sets the Account Name to "username".

  -pass password        Sets the Account Password to "password". This
                        shouldn't be used unless you know that you are
                        the only person who can access the shortcut or
                        batch file that you add this parameter into.

  -login                Attempts to automatically login one time at
                        program startup. The chances of success are
                        greatly improved if you use this with -user and
                        -pass parameters.

  -sleep 5              Sets the sleep time between screen updates to,
                        5ms which should end up being close to 200fps on
                        a high end gaming rig. You probably shouldn't set
                        this much less than that because it will just
                        consume more cpu for little or no benefit.

                        Lowering this value has no benefit on low end
                        machines as they will often use 100% cpu anyway.
                        Raising it to somewhere around 8 or 10 on a high
                        end machine can, however, result in cpu load to
                        drop close to 0 while still having ~100 fps.

  -debug                This sets the game in debug mode that shows the
                        fps on the top left corner and writes a log of
                        everything that happens in debug.xml. This will
                        cause the game to become really sluggish because
                        the log is often written and flushed to the disc
                        in the middle of screen updates.

  -dynamic              The game loads resources dynamically instead of
                        preloading them at startup. This may save some
                        seconds on startup but may also lead to sluggish
                        feeling in cases when a lot of new resources are
                        loaded at once.

  -windows              The game writes offline saves in My Documents/
                        Rogue's Tale instead of the folder the game is
                        installed in.

  -uselocal             The game uses local server list (servers.xml)
                        located in the game's folder instead of
                        automatically downloading the latest one from
                        the internet.

Example: Rogue.exe -user username -w 1600 -h 900

         Opens the game in a 1600x900 window with a visible title bar and
         borders and sets the Account Name to username for faster login.
         The window is centered to the screen because no location is set.



Modifying servers.xml:
-------------------------------------------------------------------------

The game uses servers.xml to determine the remote servers the game can
login to. The file looks something like this by default:

<list name="Server list" index="0">
  <server name="Offline"/>
  <server name="Localhost" host="127.0.0.1" port="45678"/>
  <server name="Epixx.org" host="www.epixx.org" port="45678"/>
</list>

If you know of a server maintained on some remote address and you'd like
to play on it, you can add it to the list by copying one of the entries
and replacing the values to match the server in question. This will,
however, require that you start the client with -uselocal or the list
will be automatically overridden by one downloaded from the internet.



Using the map editor:
-------------------------------------------------------------------------

/edit                   Opens the editor.

/edit new               Opens the editor with a new map.

/edit help              Reminds you of these commands in-game.

/edit check             Checks that the map does not break design guide
                        lines, such as having gazillion chests is bad.

/edit save              Saves the map on your computer in the maps folder
                        located under the game's installation folder or
                        under "My Documents/Rogue's Tale".
                        
                        UNLESS YOU WANT TO FILL YOUR MAPS FOLDER WITH
                        IDENTICAL MAPS, DO NOT USE THIS TO "SAVE" THE
                        MAP BECAUSE IT IS DONE AUTOMATICALLY WHEN YOU
                        EXIT THE EDITOR OR THE GAME. THIS COMMAND IS
                        INTENDED TO BE USED ONLY WHEN THE MAP IS READY
                        AND YOU WANT TO ADD IT IN THE GAME.
                        
                        Note that it also uploads the map on the server
                        for other players if you are playing online and
                        the following requirements are met:
                        
                        1. The map gets through /edit check
                        2. Your current rogue has reached level 11+.
                        3. It is the first (and only) map uploaded by
                           your current rogue.



Map editor user interface:
-------------------------------------------------------------------------

The map editor has three paint modes; floor, overlay and tiles. When
the floor is selected, left click draws a floor and right click draws
a wall. When the overlay tile is selected, left click applies overlay
and right click removes it. When any other tile is selected, left
click draws the selected tile and right click removes a tile.

MMB                     Hold down the middle mouse button to drag the
                        map around.

Esc                     Closes the map editor and saves the map on the
                        hard drive in editor.rtm file.

Alt                     Brings up the tile selector when held down and
                        hides it when relesed.

Ctrl                    Hold down and drag with left mouse button to
                        remove rectangles from the current selection.

Shift                   Hold down and drag with left mouse button to
                        add rectangles to the current selection.

Enter                   Performs left click on all selected tiles
                        (works in floor or overlay mode only).

Delete                  Performs right click on all selected tiles
                        (works in floor or overlay mode only).

Ctrl-A                  Selects everything.

Ctrl-I                  Inverts selection.

Note that you can remove maps simply by deleting them from the maps
folder located under the game's installation folder or under
"My Documents/Rogue's Tale".
