User Tools

Site Tools


client:optional_parameters

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
client:optional_parameters [2018/03/21 11:58]
karl [-sound] Add description
client:optional_parameters [2024/12/30 16:39] (current)
leaf Remove known client issues link
Line 1: Line 1:
 ====== Crossfire Client launch Options ====== ====== Crossfire Client launch Options ======
  
-The default Crossfire x11, gtk, gtk-v2 [[:client]] recognizes the following parameters or arguments when it starts ​:+The default Crossfire x11, gtk, gtk-v2 [[:client]] recognizes the following parameters or arguments when it starts.  
 + 
 +See also the [[man6_cfclient_6_manualpage|manpage]] and the [[gdefaults]] configuration file. 
  
 ==== -cache ==== ==== -cache ====
 Short: ​     - Cache images for future use. Short: ​     - Cache images for future use.
 +
 +gdefaults Entry: [[gdefaults#​cacheimages]] 1
  
 ==== -nocache ==== ==== -nocache ====
 Short: ​     - Do not cache images (default action). Short: ​     - Do not cache images (default action).
 +
 +gdefaults Entry: [[gdefaults#​cacheimages]] 0
 +
 +==== -keepcache ====
 +Short: ​     - Keep already cached images even if server has different ones.
 +
 +X11 cfclient only.
  
 ==== -darkness ==== ==== -darkness ====
 Short: ​     - Enables darkness code (default) Short: ​     - Enables darkness code (default)
 +
 +In length: Each of the three crossfire clients have their own map drawing code. \\
 +Variables are //​CONFIG_DARKNESS//​ , //​the_map.cells[mx][my].have_darkness//​ , //​the_map.cells[mx][my].darkness//​ and  //​CONFIG_FOGWAR//​ . 
 +  - **X11** cfclient: Function //​display_mapcell()//​ in //​client/​x11/​x11.c// ​
 +    * seems to do something ...
 +  - **GTK-1** gcfclient: Function //​display_mapcell()//​ in //​client/​gtk/​map.c//​ just uses //​CONFIG_FOGWAR// ​   ​
 +    *and draws //​the_map.cells[mx][my].darkness//​ anyway ... 
 +  - **GTK-2** gcfclient2: Functions //​opengl_gen_map()//​ and //​opengl_light_space()//​ in //​client/​gtk-v2/​src/​opengl.c// ​
 +    * are using it in a larger scale with code disabled by //#if 0// .
 +
 +Basically: Works (partly) for x11 cfclient and gtk2 gcfclient2 in [[#​-opengl]] mode, but does not do anything supplied to the gtk-1 gcfclient . \\
 +In [[#-sdl]] mode, this commandline option will have no effect at all.
 +
 +gdefaults Entry: [[gdefaults#​darkness]] 1
  
 ==== -nodarkness ==== ==== -nodarkness ====
 Short: ​     - Disables darkness code Short: ​     - Disables darkness code
 +
 +gdefaults Entry: [[gdefaults#​darkness]] 0
  
 ==== -display ==== ==== -display ====
Line 20: Line 48:
 ==== -download_all_faces ==== ==== -download_all_faces ====
 Short: ​     - Download all needed faces before play starts Short: ​     - Download all needed faces before play starts
 +
 +gdefaults Entry: [[gdefaults#​download_all_images]] 1
  
 ==== -echo ==== ==== -echo ====
 Short: ​      - Echo the bound commands Short: ​      - Echo the bound commands
 +
 +gdefaults Entry: [[gdefaults#​echo_bindings]] 1
  
 ==== -noecho ==== ==== -noecho ====
 Short: ​      - Do not echo the bound commands (default) Short: ​      - Do not echo the bound commands (default)
 +
 +gdefaults Entry: [[gdefaults#​echo_bindings]] 0
  
 ==== -faceset ==== ==== -faceset ====
-Sort: -faceset <​name> ​       - Use faceset <​name>​ if available+Sort: -faceset <​name> ​       - Use faceset <​name>​ if available ​\\ 
 +Names : classic | standard 
 + 
 +gdefaults Entry: [[gdefaults#​faceset]] 
 + 
 +The X11 cfclient does not use <​name>​ as argument, but <​number>​ ( likely 0 and 1 for classic and standard ) .
  
 ==== -fasttcpsend ==== ==== -fasttcpsend ====
 Short: ​    - Send data immediately to server, may increase bandwidth Short: ​    - Send data immediately to server, may increase bandwidth
 +
 +gdefaults Entry: [[gdefaults#​fasttcpsend]] 1
  
 ==== -nofasttcpsend ==== ==== -nofasttcpsend ====
 Short: ​    - Disables fasttcpsend Short: ​    - Disables fasttcpsend
 +
 +gdefaults Entry: [[gdefaults#​fasttcpsend]] 0
  
 ==== -fog ==== ==== -fog ====
 Short: ​     - Enable fog of war code Short: ​     - Enable fog of war code
 +
 +gdefaults Entry: [[gdefaults#​fog_of_war]] 1
  
 ==== -help ==== ==== -help ====
Line 43: Line 88:
  
 ==== -iconscale ==== ==== -iconscale ====
-Short: ​     - Set icon scale percentage+Short: ​ ​-iconscale % %    ​- Set icon scale percentage 
 + 
 +gdefaults Entry: [[gdefaults#​iconscale]]
  
 ==== -loglevel ==== ==== -loglevel ====
Line 49: Line 96:
 Description:​ The client has 5 logging levels as **0-4** . In opposite to the [[:server]] \\ Description:​ The client has 5 logging levels as **0-4** . In opposite to the [[:server]] \\
 that has just 4 logging levels, they are less talk-active when set to a high value. \\  that has just 4 logging levels, they are less talk-active when set to a high value. \\ 
-[[gdefaults]] ​entry: No \\+[[gdefaults]] ​Entry: No \\
 Default : //​common/​config.h//​ /* Default logging level. */ #define MINLOGLEVEL 0 \\ Default : //​common/​config.h//​ /* Default logging level. */ #define MINLOGLEVEL 0 \\
 Defines: //​common/​client.h//​ , //​common/​misc.c//​ Defines: //​common/​client.h//​ , //​common/​misc.c//​
Line 75: Line 122:
  
 ==== -mapscale ==== ==== -mapscale ====
-Short: -mapscale %%    - Set map scale percentage+Short: -mapscale % %    - Set map scale percentage. \\ 
 +Default: 100 \\ 
 +Range: (float) 25 - 200 \\ 
 +Syntax: -mapscale 70 | -mapscale 70% \\ 
 +gdefaults Entry: [[gdefaults#​mapscale]] \\ 
 +Description:​ Make tiles, players, items on maps appear smaller or larger. \\ 
 +Useful to chose smaller percentages when using a large [[#​-mapsize]] . 
 + 
 +Source Code files and functions : 
 +  * gtk-v2/​src/​main.c 
 +    * parse_args() 
 +  * gtk-v2/​src/​config.c 
 +    * setup_config_window() 
 + 
 +gdefaults Entry: [[gdefaults#​mapscale]]
  
 ==== -mapsize ==== ==== -mapsize ====
-Short: -mapsize xXy     - Set the mapsize to be X by Y spaces. ​(default 11x11)+Short: -mapsize xXy     - Set the mapsize to be X by Y spaces. ​\\ 
 +gdefaults Entries: [[gdefaults#​map_width]] , [[gdefaults#​map_height]] \\ 
 +Default: gtk1: 11x11; gtk-2: old 15x15, new 25x25 
 + 
 +For a new installation of the GTK-1 client without any configuration files, the default ​map size of 11x11 might lead to a slightly distorted GUI. \\ 
 +''​-mapsize 9x9''​ might be a better first impression without stat bars / resistances column overlapping the bottom of the map: 
 + 
 +^ mapsize default ^ mapsize 9 x 9 ^ 
 +| {{gcfclient_mapsize_default.jpg?​350}} | {{gcfclient_mapsize_9x9.jpg?​350}} | 
 + 
 + 
 + 
 + 
  
 ==== -mapscroll ==== ==== -mapscroll ====
Line 88: Line 162:
          * from outside the view area. */           * from outside the view area. */ 
 Default : TRUE ( apparently ) \\ Default : TRUE ( apparently ) \\
-[[gdefaults]] file entry : ''​mapscroll:​ <​0|1>'' ​ ( guessed TRUE | FALSE ) \\+
 Client Menu entry : UNKNOWN \\ Client Menu entry : UNKNOWN \\
 Bugs : x11/x11.c: Fix display_mapscroll() to handle scrolling by greater than 1 tile at a time. Fixes bug #1564584. \\ Bugs : x11/x11.c: Fix display_mapscroll() to handle scrolling by greater than 1 tile at a time. Fixes bug #1564584. \\
Line 100: Line 174:
   * display_mapscroll in //​gtk/​map.c//​ , returns either 0 or sdl_mapscroll,​ called by //​mapdata_scroll//​ in //​common/​mapdata.c//​   * display_mapscroll in //​gtk/​map.c//​ , returns either 0 or sdl_mapscroll,​ called by //​mapdata_scroll//​ in //​common/​mapdata.c//​
   * sdl_mapscroll in //​gtk/​sdl.c//​ , returns always '​1'​ , called by //​display_mapscroll// ​   * sdl_mapscroll in //​gtk/​sdl.c//​ , returns always '​1'​ , called by //​display_mapscroll// ​
 +
 +gdefaults Entry: [[gdefaults#​mapscroll]] 1
  
 ==== -nomapscroll ==== ==== -nomapscroll ====
Line 105: Line 181:
  
 Function //​common/​mapdata.c//​ mapdata_scroll says: ''/​* Emulate map scrolling by redrawing all tiles. */''​ Function //​common/​mapdata.c//​ mapdata_scroll says: ''/​* Emulate map scrolling by redrawing all tiles. */''​
 +
 +gdefaults Entry:​[[gdefaults#​mapscroll]] 0
 +
 +==== -noautorepeat ====
 +Short: ​ - Auto repeat on directional keys is ignored.
 +
 +X11 cfclient only.
 +
 +==== -opengl ====
 +Short: ​     - Use opengl drawing code
 +
 +gdefaults Entry: [[gdefaults#​displaymode]] 2
 +
 +Only available for the GTK-2 client.
 +
 +
 +Though the OpenGL drawing mode apparently works even without the GLX extension switched on for the XServer, \\
 +the older GTK-2 clients will crash at startup if the GLX extension would be not available:
 +<code bash>
 +# gcfclient2-1.10.0 -opengl
 +Xlib:  extension "​GLX"​ missing on display ":​0.0"​.
 +Segmentation fault
 +</​code>​
 +
 +The newer GTK-2 clients will work still, if the necessary libraries ''​libGL.so.1''​ , ''​libGLU.so.1''​ and ''​libglut.so.3''​ are available on the system:
 +<code bash>
 +# crossfire-client-gtk2-1.70.0 -opengl
 +[  INFO  ] (gtk-v2::​init_glx_opengl) Direct rendering is not available!
 +[  INFO  ] (gtk-v2::​opengl_common) Maximum texture size is 2048
 +[  INFO  ] (gtk-v2::​init_image_cache_data) Init Image Cache
 +</​code>​
 +
 +When OpenGL had not been available at [[client compiling]] time, then the client will fall back to Pixmap mode, and prints to stderr
 +<code bash>
 +# crossfire-client-gtk2-1.70.0 -opengl
 +[WARNING ] (main.c::​init_windows) client not compiled with opengl support. ​ Ignoring -opengl
 +</​code>​
 +
 +
 +==== -pixmap ====
 +Short: ​     - Use pixmap drawing code
 +
 +gdefaults Entry: [[gdefaults#​displaymode]] 0
 +
 +Only available for the GTK-2 client.
  
 ==== -popups ==== ==== -popups ====
Line 114: Line 235:
 See also ChangeLog entry : [[changelog_0_92_1_70_0#​Popups not the default anymore]] See also ChangeLog entry : [[changelog_0_92_1_70_0#​Popups not the default anymore]]
    
-[[gdefaults]] settings file entry : [[gdefaults#​popups]]+gdefaults ​Entry: [[gdefaults#​popups]] ​1
  
 The GTK-v1 gcfclient when configured to partly use GTK-2 features by the ''​-–enable-cfgtk2''​ configure option, had a bug in the 1.9.1, 1.10.0 and 1.11.0 versions, that made new players impossible to log-on to a crossfire [[:server]] , because a log-in required the popup-login-GUI to function. The GTK-v1 gcfclient when configured to partly use GTK-2 features by the ''​-–enable-cfgtk2''​ configure option, had a bug in the 1.9.1, 1.10.0 and 1.11.0 versions, that made new players impossible to log-on to a crossfire [[:server]] , because a log-in required the popup-login-GUI to function.
Line 121: Line 242:
   * ChangeLog [[changelog_0_92_1_70_0#​Keyboard input impossible or confusing]]   * ChangeLog [[changelog_0_92_1_70_0#​Keyboard input impossible or confusing]]
   * ChangeLog [[changelog_0_92_1_70_0#​Popups @ v.1.12.0 client GTK1 mixed with GTK2 can not login]]   * ChangeLog [[changelog_0_92_1_70_0#​Popups @ v.1.12.0 client GTK1 mixed with GTK2 can not login]]
-  * known_client_issues [[:​known_client_issues#​Keyboard input impossible or confusing]] 
   * bugs [[bugs#​Pressing a keyboard key activates the command-line]] ​   * bugs [[bugs#​Pressing a keyboard key activates the command-line]] ​
- 
  
  
 ==== -nopopups ==== ==== -nopopups ====
 Short: ​     - Don't use pop up windows for input Short: ​     - Don't use pop up windows for input
 +
 +gdefaults Entry: [[gdefaults#​popups]] 0
  
 ==== -port ==== ==== -port ====
 Short: -port <​number> ​      - Use port <​number>​ instead of the standard port number Short: -port <​number> ​      - Use port <​number>​ instead of the standard port number
 +
 +gdefaults Entry: [[gdefaults#​port]] 13327
 +
 +==== -pngfile ====
 +Short: -pngfile <​name> ​ - Use <​name>​ for source of images
 +
 +X11 cfclient only.
  
 ==== -resists ==== ==== -resists ====
 Short: -resists <​val> ​     - Control look of resistances.  ​ Short: -resists <​val> ​     - Control look of resistances.  ​
 +
 +gdefaults Entry: [[gdefaults#​resistances]]
 +
 +GTK-1 client gcfclient only.
 +
 +==== -scrolllines ====
 +Short: -scrolllines <​number> ​   - number of lines for scrollback \\
 +Default: #define INFOLINES 36 in //​client/​x11/​x11.c//​
 +
 +X11 cfclient only. \\
 +This default value of 36 is much too small when identifying many books at once.
  
 ==== -sdl ==== ==== -sdl ====
 Short: ​     - Use sdl for drawing png (may not work on all hardware Short: ​     - Use sdl for drawing png (may not work on all hardware
 +
 +gdefaults Entry: [[gdefaults#​displaymode]] 1
  
 ==== -server ==== ==== -server ====
 Short: -server <​name> ​      - Connect to <​name>​ instead of localhost. Short: -server <​name> ​      - Connect to <​name>​ instead of localhost.
 +
 +gdefaults Entry: [[gdefaults#​server]]
  
 ==== -showicon ==== ==== -showicon ====
 Short: ​     - Print status icons in inventory window Short: ​     - Print status icons in inventory window
 +
 +gdefaults Entry: [[gdefaults#​showicon]] 1
  
 ==== -smooth ==== ==== -smooth ====
 Short: ​     - Enable smooth Short: ​     - Enable smooth
  
 +gdefaults Entry: [[gdefaults#​smoothing]] 1
 +
 +If one likes it ... Wolfsburg harbour quays and Stoneville north-east ... \\
 +{{smooth-dmode0-wolfsburg_beach.jpg}} {{smooth_stoneville_countryside2.jpg}}
 ==== -nosmooth ==== ==== -nosmooth ====
 Short: ​     - Disable smooth Short: ​     - Disable smooth
 +
 +gdefaults Entry: [[gdefaults#​smoothing]] 0
  
 ==== -sound ==== ==== -sound ====
Line 156: Line 307:
 The sound serer is the only external program launched by the client. \\ The sound serer is the only external program launched by the client. \\
 The code is in the function //​raiseChild()//​ found in //​client/​common/​misc.c//​ . \\ The code is in the function //​raiseChild()//​ found in //​client/​common/​misc.c//​ . \\
-The LOG prints to standard ​output ​:+The LOG function ​prints to standard ​error :
 >>>​[ ​ INFO  ] (common::​raiseChild) Raising /​usr/​local/​bin/​cfsndserv with flags 7 >>>​[ ​ INFO  ] (common::​raiseChild) Raising /​usr/​local/​bin/​cfsndserv with flags 7
  
 +gdefaults Entry: [[gdefaults#​sound]] 1
  
 ==== -nosound ==== ==== -nosound ====
Line 173: Line 325:
 </​code>​ </​code>​
 Benefits: The cfsndserv binary blocks the audio device for other users. \\ Benefits: The cfsndserv binary blocks the audio device for other users. \\
-It is therefore likely ​desireable ​to disable the usage of that child process, \\+It is therefore likely ​desirable ​to disable the usage of that child process, \\
 when there are other sound programs running in parallel. ​ when there are other sound programs running in parallel. ​
 +
 +gdefaults Entry: [[gdefaults#​sound]] 0
 +
 ==== -sound_server ====  ==== -sound_server ==== 
 Short: -sound_server <​path>​ - Executable to use to play sounds. Short: -sound_server <​path>​ - Executable to use to play sounds.
 +
 +gdefaults Entry: [[gdefaults#​sound_server]]
  
 ==== -splash ==== ==== -splash ====
 Short: ​     - Display the splash screen (startup logo) (default) Short: ​     - Display the splash screen (startup logo) (default)
 +
 +gdefaults Entry: [[gdefaults#​nosplash]] 0
  
 ==== -nosplash ==== ==== -nosplash ====
 Short: ​     - Don't display the splash screen ​ Short: ​     - Don't display the splash screen ​
 +
 +gdefaults Entry: [[gdefaults#​nosplash]] 1
  
 ==== -split ==== ==== -split ====
 Short: ​     - Use split windows. Short: ​     - Use split windows.
 +
 +gdefaults Entry: [[gdefaults#​split]]
  
 ==== -splitinfo ==== ==== -splitinfo ====
 Short: ​     - Use two information windows, segregated by information type. Short: ​     - Use two information windows, segregated by information type.
 +
 +gdefaults Entry: [[gdefaults#​splitinfo]]
 +
 +==== -sync ====
 +Short: ​      - Synchronize on display
 +
 +X11 cfclient only.
  
 ==== -timemapredraw ==== ==== -timemapredraw ====
client/optional_parameters.1521651482.txt.gz · Last modified: 2018/03/21 11:58 by karl