-------------------------------------------------------
ketrun - (starter)-Tool for Wolfenstein:Enemy Territory
-------------------------------------------------------
Package: ketrun.tar.gz
  Files: ketrun, README-ketrun
 Author: Klaus Fischer, ET-nick: FischCommand :)
 E-Mail: FischCommander(AT)arcor.de
Version: 1.2 Beta
-------------------------------------------------------
 
 
##############################################
# IMPORTANT! Please remove any old .ketrunrc #
# before you install the new ketrun version  #
##############################################
 
 
README-ketrun content:
======================


  1. REQUIREMENTS
  
  2. FEATURES
  
  3. INSTALL
  
  4. KETRUNRC
  
  5. COMMANDLINE
  
  6. NOTES
  
  7. LINKS
  
  8. DOWNLOADS
 
 
  
1. REQUIREMENTS:
================
- Installed Enemy Terrritory. Who would have thought it? ;)
- KDE with kdialog (kdialog package is a part of kdebase-bin)
- Or any Windowmanager with KDE-/kdialog supporting
- Newest PB (Punkbuster) file 'pbsetup.run' in ~/.etwolf/pb

  RECOMMENDED:
  -----------
  - ketrun tested with Ubuntu 9.10 and KDE 4.x.x
  - Installed 'qstat' server browser
    Info: http://www.qstat.org/
 
  OPTIONAL:
  ---------
  - A game server Browser like 'xqf' or other
 
 
 
2. FEATURES:
============
 
  menu:
  -----
    - Run ET map                (default: battery, fueldump, goldrush, oasis,
      radar, railgun)
    - Run ET custom map         (run any ET custom maps from $HOME/.etwolf/etmain)
    - Edit ET start parameters  (edit/change the command line for running ET)
    - Edit ET cfg file(s)       (edit one or more ET config files with your $editor)
    - Show ET log file          (show etconsole.log file (logging must be enabled in ET))
    - Show ET shots             (show screenshots from $HOME/.etwolf/etmain/screenshots)
    - Play ET demo file         (play a .dm_83 or.dm_84 ET demo file)
    - Gameserver Browser        (select an external game browser)
    - Change/Connect Server     (Change an ET Server for MP Gaming or connect to Server)
    - Show Server stats         (Show server stats with your $editor) 
    - Punkbuster Update         (manually update of Punkbuster with last date of update)
    - Preferences (.ketrunrc)   (Edit the variables in $HOME/.ketrunrc)
    - Show README-ketrun        (Show this README file with your $editor)
   
     
  Optional soundfix in ketrun for ET:
  -------------------------------------
    comment out follow line in ketrun:
    # echo "et.x86 0 0 direct" > /proc/asound/card0/pcm0p/oss    
    # (you should have user rights of sound device
    # /proc/asound/card0/pcm0p/oss)
    # (if you run ET as root no user rights needed for the sound device)
     
      
 
3. INSTALL:
===========
a) IF YOU UPDATE ketrun: Remove an existing $HOME/.ketrunrc first
b) Extract package with 'tar xfvz ketrun.tar.gz' eg. in /usr/local/bin
c) Run ketrun
d) Select your ET MAIN directory (NOT $HOME/.etwolf) ;)
e) Choose your preferred Editor (multi edit Editor)
f) Choose your preferred Game Browser eg. xqf
g) Choose your preferred Screenshot Browser e.g. gwenview
h) Edit/Change your start parameters for running ET
i) Choose your preferred ET Server for Multiplayer Game and
   test later with the option 'Show actual Server stats'
 
 
4. KETRUNRC ($HOME/.ketrunrc)
=============================
 
  Variables
  ---------
  a) etpath    (Your ET path (default: /usr/local/games/enemy-territory)) 
  b) ethome    (Change this path if NOT $HOME/.etwolf)
  c) editor    (Recommended: multi edit Editor)
  d) gserver   (Your preferred Gameserver Browser program)
  e) scrprg    (Your preferred Screenshot Browser program)
  f) et_cmd    (Start parameters for ET, default: "+sv_pure 0 +g_gametype 2")
  g) ET_server (Your preferred ET Game Server for Multiplayer)
 
  Examples:
  ---------
  etpath=/usr/local/games/enemy-territory
  ethome=/home/etplayer/.etwolf
  editor="konsole -e vim"
  gserver=/usr/local/bin/xqf
  scrprg=/opt/kde3/bin/gwenview
  bmarks="goldfinger goldfinger-snow SecRadar3_final"
  et_cmd="set fs_game etpub +sv_pure 0 +g_gametype 2"
  ET_server="83.141.24.110:27960" (*XP* kernwaffe.de NQ No1)
 
 
5. COMMANDLINE:
===============
    options
      -m mapname    (Start map directly)
      -c IP[:port]  (connect to ET Server)
     --version      (return versions number
     --help|-h      (show this help)
  
 
6. NOTES:
=========
a) If you upgrade ketrun, please DELETE ANY OLD .ketrunrc!
   (Not recommended: edit/add {new} variables in .kderunrc)
b) For some functions of ketrun you must be online!
c) ketrun works only for ET standard mod or for the etpub
   mod. ETPRO DOESN'T WORK! Other mods aren't tested.
   (see in examples for var: et_cmd 'fs_game' parameter).
d) You find version info about ketrun in the title bar of menu
   or with commandline parameter: ketrun --version
e) It is possible the 'Run ET maps' menu to extend with own
   entries (your favourite maps). Edit .ketrunrc and change
   the line "battery fueldump goldrush oasis radar railgun"
   (don't forget the closed "" sign for the map line)
g) Sometimes the filemap name is other than the real mapname.
   If ET your map not found then look into .pk3 file in the
   dir /scripts/[mapname].arena for the entry "map" and use
   this name! E.g.: the true mapname of "industry2_final"
   is "industry2". I don't now why sometimes the authors
   this has made different?
h) For logging, set variable in your autoexec.cfg:
			// LOGGING
			set g_logsync 0
			set logfile 2
			set g_log "etconsole.log"
    
 
7. LINKS:
=========
 
  A very nice tutorial for ET Beginners (in German)
  -------------------------------------------------
  http://planetwolfenstein.ingame.de/maps_et/index.php
    
 
  Infos about Enemy-Territory and my own custom maps:
  ---------------------------------------------------
  http://www.k-fisch.de/et/
  
 
  SCREENSHOT ketrun:
  ------------------
  http://www.k-fisch.de/et/tools.html#ketrun
 
 
8. DOWNLOADS:
=============
 
  DOWNLOAD ketrun for Linux (4 kb):
  ---------------------------------
  http://www.k-fisch.de/et/ketrun.tar.gz
 
  
  DOWNLOAD etrun for Windows (1.8 MB):
  ------------------------------------
  http://www.k-fisch.de/et/ETRun.exe

  
  qstat - Server Browser for many Gameserver
  ------------------------------------------
  http://prdownloads.sourceforge.net/qstat/qstat-2.6.tar.gz?download
 
  
  xqf - Game Server Browser with GUI
  ----------------------------------
  http://sourceforge.net/projects/xqf

  
  Punkbuster - Download with GUI
  ------------------------------
  http://www.evenbalance.com/index.php?page=support-et.php
 


