tDocumentation updated for upcoming version 1.5.2 - vaccinewars - be a doctor and try to vaccinate the world (HTM) git clone git://src.adamsgaard.dk/vaccinewars (DIR) Log (DIR) Files (DIR) Refs (DIR) README (DIR) LICENSE --- (DIR) commit 9dd5257c76850df3068e9dc3f2f7594cb93d2b49 (DIR) parent ef8b7fb22cc38b2e2ef53049fe0e3eb597fda1d8 (HTM) Author: Ben Webb <ben@salilab.org> Date: Mon, 15 Oct 2001 15:45:54 +0000 Documentation updated for upcoming version 1.5.2 Diffstat: M ChangeLog | 2 ++ M INSTALL | 33 +++++++++++++++++++++++++++++++ M README | 26 +++++++++++++------------- M TODO | 3 --- M doc/configfile.html | 16 +++++++++++++++- M doc/index.html | 4 ++-- M doc/installation.html | 34 +++++++++++++++++++++---------- M doc/windows.html | 6 ++++-- 8 files changed, 92 insertions(+), 32 deletions(-) --- (DIR) diff --git a/ChangeLog b/ChangeLog t@@ -1,4 +1,6 @@ cvs + - Slightly easier-to-use "run from fight" Jet dialog (avoids the crazy + "windows pop up faster than you can close them" syndrome) - Support for HTTP proxies and authentication - SOCKS4 and SOCKS5 (user/password) support - French translation added by leonard (DIR) diff --git a/INSTALL b/INSTALL t@@ -1,9 +1,37 @@ +PREREQUISITES + +dopewars _requires_ the GLib library for compilation, even when not using +the GTK+ client. Other libraries may be required for additional features:- + +Windows: + - Get Cygwin from http://sourceware.cygnus.com/cygwin/. It should be + possible to build dopewars with C compilers other than Cygwin, but + this is not supported. + - Get GLib from http://user.sgic.fi/~tml/gimp/win32/. The various header + files need to be placed in /usr/include/mingw32/ of your Cygwin + installation, while the GLib DLL eventually needs to be placed either + in the same directory as the dopewars binary, or your Windows directory. + Later versions of GLib depend on IConv, so also install this if required. + +Unix/Linux: + - Get GLib from http://www.gtk.org/ + - For the GTK+ client, GTK+ libraries are needed, also from + http://www.gtk.org/. To actually compile dopewars, you'll probably need + your distribution's "gtk-devel" package. + - For the curses client, curses, ncurses or libcurses_color libraries + and headers are required. + +INSTALLATION + dopewars installation should require no more than the following:- ./configure make make install +(If you also wish to build the Windows installer program, see the instructions +in the win32/ subdirectory of the dopewars source code distribution.) + The configure script checks to see if your system is a "normal" Unix or the Unix-under-Win32 "Cygwin" environment. On a Cygwin system, the default is to build a native Win32 binary with the Cygwin tools; this will then run without t@@ -64,6 +92,11 @@ if you have ncurses (or similar) installed. specified, this is enabled under Windows and disabled under Unix (where a simple text-mode server is used instead). +--enable-strict + If using gcc to compile dopewars (recommended) then this turns on +extra warning messages (useful for debugging, etc.) Unfortunately a lot of +these warnings can be safely ignored, so this is not the default. + Basic Installation ================== (DIR) diff --git a/README b/README t@@ -1,13 +1,13 @@ -This is dopewars 1.5.1, a game simulating the life of a drug dealer in +This is dopewars 1.5.2, a game simulating the life of a drug dealer in New York. The aim of the game is to make lots and lots of money... unfortunately, you start the game with a hefty debt, accumulating interest, and the cops take a rather dim view of drug dealing... These are brief instructions; see the HTML documentation for full information. -dopewars 1.5.1 servers should handle clients as old as version 1.4.3 with +dopewars 1.5.2 servers should handle clients as old as version 1.4.3 with hardly any visible problems (the reverse is also true). However, it is -recommended that both clients and servers are upgraded to 1.5.1! +recommended that both clients and servers are upgraded to 1.5.2! INSTALLATION t@@ -17,10 +17,10 @@ Either... Or... -2. Get the tarball dopewars-1.5.1.tar.gz from the same URL - Extract it via. tar -xvzf dopewars-1.5.1.tar.gz +2. Get the tarball dopewars-1.5.2.tar.gz from the same URL + Extract it via. tar -xvzf dopewars-1.5.2.tar.gz Follow the instructions in the INSTALL file in the newly-created - dopewars-1.5.1 directory + dopewars-1.5.2 directory Once you're done, you can safely delete the RPM, tarball and dopewars directory. The dopewars binary is all you need! t@@ -31,11 +31,11 @@ score file can be selected with the -f switch. WIN32 INSTALLATION -dopewars now compiles as a console application under Win32 (Windows 95,98,NT). -Almost all functionality of the standard Unix binary is retained; for example, -all of the same command line switches are supported, and configuration files -are still looked for in $HOME/.dopewars (so set the environment variable HOME -to something sensible if it is not set and you want to use this feature). +dopewars now compiles as a console or regular application under Win32 +(Windows 95,98,NT,2000). Almost all functionality of the standard Unix binary +is retained; for example, all of the same command line switches are supported, +and configuration files are still looked for in $HOME/.dopewars. However, for +convenience, the configuration file "dopewars-config.txt" is also read. The easiest way to install the Win32 version is to download the precompiled binary. The supplied configure script, however, should build the binary t@@ -58,13 +58,13 @@ messages back and forth, and shoot each other if they really want to... dopewars -s Starts a dopewars server. By default this is an interactive server; if you -want to put it in the background, then run it as +want to put it in the background (on a Unix system) then run it as "dopewars -s < /dev/null > /dev/null &" or similar. dopewars -c Create and run a computer dopewars player. This will attempt to connect to a dopewars server, and if this succeeds, it will then participate in -multi-player dopewars games. At the moment, it does next to nothing, however! +multi-player dopewars games. CONFIGURATION (DIR) diff --git a/TODO b/TODO t@@ -1,8 +1,5 @@ -- Improve error reporting for network operations (e.g. metaserver) - GSS_API SOCKS support? -- Busy loop in GTK+ client on server crash - seems to be a GLib bug - Fix problem with dialogs popping up while menus are open -- Fix problem with Jet dialog during fights - Increase difficulty of escaping from another player - impose penalty on running (lose drugs, free shot, destination revealed) - Alliances/cartels - several players share cash (DIR) diff --git a/doc/configfile.html b/doc/configfile.html t@@ -95,7 +95,21 @@ metaserver communications - see the MetaServer.UseSocks variable. N.B. You cannot run a dopewars server behind a SOCKS server, due to limitations in the SOCKS protocol. -<dt><b>Socks.Name=<i>socks</i></b></a> +<dt><b>Socks.NumUID=<i>FALSE</i></b></a> +<dd>When connecting to a SOCKS version 4 server, the protocol demands that +the name of the current user be sent for simple authentication; the SOCKS +server then queries identd on your machine to check if you are who you say +you are. dopewars complies with this requirement if this variable is set to +FALSE. However, some Unix implementations of identd send numeric user IDs +rather than user names; dopewars will do the same if you set this variable +to TRUE. (N.B. Not supported on Windows systems.) + +<dt><b>Socks.User=<i>"fred"</i></b></a> +<dd>Overrides the username detection (discussed above) completely, and instead +sends the user name <i>"fred"</i> to a SOCKS4 server. If this is set to the +blank string ("") - the default - this does not happen. + +<dt><b>Socks.Name=<i>"socks"</i></b></a> <dd>If using SOCKS, sets the hostname of the SOCKS server to connect to to be <i>"socks"</i>. (DIR) diff --git a/doc/index.html b/doc/index.html t@@ -3,11 +3,11 @@ <html> <head> -<title>dopewars 1.5.1: Main Index</title> +<title>dopewars 1.5.2: Main Index</title> </head> <body> -<h1>dopewars 1.5.1: Main Index</h1> +<h1>dopewars 1.5.2: Main Index</h1> <table> (DIR) diff --git a/doc/installation.html b/doc/installation.html t@@ -29,11 +29,23 @@ equivalent, such as ncurses or cur_colr) for the text-mode client, and the <a href="http://www.gtk.org/">GTK+</a> libraries for the graphical client.</p> <ul> +<li><a href="#win32">Windows installation</a> <li><a href="#rpmbinary">RPM binary installation</a> <li><a href="#rpmsource">RPM source installation</a> <li><a href="#tarball">Tarball installation</a> </ul> +<h2><a name="win32">Windows installation</a></h2> +<p>The easiest way to install the Windows version is to download the Windows +installer program from the +<a href="http://dopewars.sourceforge.net/download.html">download page</a>, and +run it (either instruct your web browser to "run from the current location", +or save it to somewhere obvious like the Desktop and then double-click on its +icon later). This should install all relevant files, and set up Start Menu +icons, etc. If, however, you wish to build the program from the source code, +see the <a href="#tarball">tarball installation</a> section below, and also +see the <a href="windows.html">Windows page</a>. + <h2><a name="rpmbinary">RPM binary installation</a></h2> <p>The binary RPMs are built for Compaq (formerly DEC) Alpha systems running RedHat Linux 7.0, and Intel (also Intel compatibles, such as AMD, Cyrix, etc.) t@@ -43,9 +55,9 @@ faults due to library conflicts.</p> <ol> <li>Download the -<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.1-1.alpha.rpm"> +<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2-1.alpha.rpm"> Alpha</a> or -<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.1-1.i386.rpm"> +<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2-1.i386.rpm"> i386 (Intel)</a> RPM with your web browser. (If your browser is incorrectly set up, it may try and display the file, in which case tell it explicitly to save the file - Shift+Mouse button 1 in Netscape.) t@@ -56,7 +68,7 @@ up). <li>Change to the directory containing the dopewars rpm, and install it with the command<br> -<tt><b>rpm -Uvh dopewars-1.5.1-1.<i>xxx</i>.rpm</b></tt><br> +<tt><b>rpm -Uvh dopewars-1.5.2-1.<i>xxx</i>.rpm</b></tt><br> (where <b><i>xxx</i></b> is i386 or alpha). This will replace any already-installed earlier version. </ol> t@@ -69,13 +81,13 @@ building the binaries from it on your system.</p> <ol> <li>Download the -<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.1-1.src.rpm"> +<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2-1.src.rpm"> source code RPM</a>. <li>Become root and change to the directory containing the new rpm. <li>Build a binary rpm with the command<br> -<tt><b>rpm --rebuild dopewars-1.5.1-1.src.rpm</b></tt> +<tt><b>rpm --rebuild dopewars-1.5.2-1.src.rpm</b></tt> <li>Change to the directory which the binary rpm has been written to (check the output of the above - usually /usr/src/redhat/RPMS/<i>xxx</i>, where t@@ -83,7 +95,7 @@ the output of the above - usually /usr/src/redhat/RPMS/<i>xxx</i>, where "alpha" on Alphas) <li>Install the binary rpm with the command<br> -<tt><b>rpm -Uvh dopewars-1.5.1-1.<i>xxx</i>.rpm</b></tt> +<tt><b>rpm -Uvh dopewars-1.5.2-1.<i>xxx</i>.rpm</b></tt> </ol> <h2><a name="tarball">Tarball installation</a></h2> t@@ -103,15 +115,15 @@ Unix <a href="http://www.gtk.org/download/">here</a> or for Windows <ol> <li>Download the -<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.1.tar.gz"> +<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2.tar.gz"> source code tarball</a>. <li>Change to the directory containing the tarball and extract the contents with the command <br> -<tt><b>tar -xvzf dopewars-1.5.1.tar.gz</b></tt><br> +<tt><b>tar -xvzf dopewars-1.5.2.tar.gz</b></tt><br> (or similar). -<li>Change into the dopewars-1.5.1 directory, and read all the important +<li>Change into the dopewars-1.5.2 directory, and read all the important documentation in there ;) <li>Build the binary with the commands<br> t@@ -125,7 +137,7 @@ should compile cleanly. If you are running the Cygwin tools under Microsoft Windows, the script should detect this and allow you to build a native Windows binary; this will then run on any Win32 system, even one without Cygwin installed. The configure script supports a number of configurable options; for -more details, read the INSTALL file in the dopewars-1.5.1 directory.<p> +more details, read the INSTALL file in the dopewars-1.5.2 directory.<p> If you cannot become root, run the configure script specifying directories for which you have write access for both the dopewars binary and high score file t@@ -138,6 +150,6 @@ with a command such as<br> <ul> <li><a href="index.html">Main index</a> </ul> -<p>Last update: <b>18-06-2001</b></p> +<p>Last update: <b>14-10-2001</b></p> </body> </html> (DIR) diff --git a/doc/windows.html b/doc/windows.html t@@ -26,7 +26,9 @@ http://user.sgic.fi/~tml/gimp/win32/</a>. The installation procedure is the same as <a href="installation.html">that for Unix systems</a> - download the tarball, extract the files, change into the created directory, run the <tt><b>configure</b></tt> script, and then <b>make</b>. This builds a native -Win32 binary, which does not need the Cygwin libraries to run.</p> +Win32 binary, which does not need the Cygwin libraries to run. See the +INSTALL file in the source code distribution (.tar.gz file) for further +details.</p> <p>In virtually all respects, the Unix and Win32 versions of dopewars should be identical. Both will accept the same command line parameters and configuration t@@ -43,7 +45,7 @@ configure in order to get this behaviour for the high score file.)</p> <ul> <li><a href="index.html">Main index</a> </ul> -<p>Last update: <b>13-05-2001</b></p> +<p>Last update: <b>14-10-2001</b></p> </body> </html>