manual

Differences

This shows you the differences between two versions of the page.

manual [2009/03/10 16:14]
datag
manual [2009/03/11 08:41] (current)
datag
Line 1: Line 1:
====== Manual ====== ====== Manual ======
-===== HoldingNuts user data directory ===== +This page has been moved to [[handbook]].
- +
-This tables shows the location of the directory containing the settings and user-files: +
- +
-^ OS ^ Directory ^ +
-| Linux | ''~/.holdingnuts/'' | +
-| Windows (all) | ''%APPDATA%\HoldingNuts\'' | +
-| * NT/XP/2000 | ''C:\Documents and Settings\<username>\Application Data\HoldingNuts\'' | +
-| * Vista | ''C:\Users\<username>\AppData\Roaming\HoldingNuts\'' | +
- +
-These files/directories can be found in it: +
- +
-^ Name ^  Type  ^ Purpose ^ +
-| ''client.cfg'' |  file  | Client configuration | +
-| ''server.cfg'' |  file  | Server configuration | +
-| ''client.log'' |  file  | Client log file //(if logging is enabled)// | +
-| ''server.log'' |  file  | Server log file //(if logging is enabled)// | +
-| ''screenshots'' |  directory  | Contains your taken screenshots | +
- +
-===== Client ===== +
-==== Configuration variables ==== +
-Most variables are configurable via the settings dialog, too. +
- +
-^ Name ^ Default value ^ Description ^ +
-| default_host | localhost | default host to connect to | +
-| default_port | 40888 | default port to connect to | +
-| player_name | Unnamed | the player name | +
-| uuid | //generated on first start// | unique ID for re-connect | +
-| locale | | language/locale to use | +
-| log | true | log to file | +
-| log_chat | false | include player chat in log | +
-| ui_show_handstrength | true | display hand strength on table | +
-| ui_card_deck | default | card deck to use //(default=4-color deck, classic=2-color deck)// | +
-| sound | true | play sounds | +
-| sound_focus | true | only play sound if window has focus | +
- +
-==== Keyboard shortcuts ==== +
- +
-=== Table === +
- +
-^  Key  ^ Function ^  +
-|  <widget key>F10</widget>  | create a screenshot | +
-|  <widget key>Ctrl</widget> + <widget key>F</widget>  | Fold (availability depends on game context) | +
-|  <widget key>Ctrl</widget> + <widget key>A</widget>  | Allin (availability depends on game context) | +
-|  <widget key>Ctrl</widget> + <widget key>B</widget>  | Bet (availability depends on game context) | +
-|  <widget key>Ctrl</widget> + <widget key>R</widget>  | Raise (availability depends on game context) | +
-|  <widget key>Ctrl</widget> + <widget key>C</widget>  | Call (availability depends on game context) | +
-|  <widget key>Ctrl</widget> + <widget key>C</widget>  | Check (availability depends on game context) | +
-|  <widget key>Ctrl</widget> + <widget key>O</widget>  | Sitout | +
-|  <widget key>Ctrl</widget> + <widget key>K</widget>  | I'm back | +
- +
-===== Server ===== +
- +
-==== Setup a server ==== +
-Setting up an own server is really simple. +
- +
-First, create a proper configuration file. The server's config file is ''server.cfg'' (see above chapters regarding the location of the file). +
-These are two possibilities to setup a config: +
-  * Start and stop the server. If there's no config-file present when the server is started, it'll create one with all available configuration options (default values). +
-  * Create an own configuration from scratch. +
- +
-Now you're ready to start the server. +
-  * Windows: The executable is called ''pserver.exe''. Run it by double-clicking on it. A windows-console window with log-messages will appear. +
-  * Linux: The executable is called ''pserver''. Run it in a terminal ''./pserver'' (relative path) or just ''pserver'' if it's in the executable path. +
-==== Configuration variables ==== +
- +
-^ Name ^ Default value ^ Description ^ +
-| port | 40888 | port the server is listening on | +
-| max_clients | 200 | limit for client connections | +
-| max_connections_per_ip | 3 | limit for connections per IP | +
-| max_register_per_player | 2 | limit for register per player | +
-| max_create_per_player | 2 | limit for creating games per player | +
-| log | true | log into file | +
-| auth_password | | server authentication password | +
-| perm_create_user | true | allow regular user to create games | +
-| conarchive_expire | 15 * 60 | stored connection data expiration (seconds) | +
-| flood_chat_interval | 10 | flood-protect: interval for measureing (seconds) | +
-| flood_chat_per_interval | 5 | flood-protect: count of messages allowed in interval | +
-| flood_chat_mute | 60 | flood-protect: mute time (seconds) |+
 
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki Get HoldingNuts at SourceForge.net. Fast, secure and Free Open Source software downloads | Site Notice | Privacy Policy