tIncorporate recent changes in docs - vaccinewars - be a doctor and try to vacc… | |
git clone git://src.adamsgaard.dk/vaccinewars | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit ea8494aafe5731a452719528ad8c274f121b49b8 | |
parent dbfe48592b364fc27d755fffc9b6dfa16b1e0347 | |
Author: Ben Webb <[email protected]> | |
Date: Sat, 5 Dec 2020 02:24:13 -0800 | |
Incorporate recent changes in docs | |
Diffstat: | |
M doc/aiplayer.html | 10 ++++------ | |
M doc/contribute.html | 30 +++++++++++++++--------------- | |
M doc/developer.html | 12 ++++++------ | |
M doc/i18n.html | 17 ++++++++++------- | |
M doc/installation.html | 37 +++++++++++++----------------… | |
M doc/metaserver.html | 2 +- | |
M doc/server.html | 16 +++++++--------- | |
7 files changed, 58 insertions(+), 66 deletions(-) | |
--- | |
diff --git a/doc/aiplayer.html b/doc/aiplayer.html | |
t@@ -46,18 +46,16 @@ for a few seconds!</p> | |
<p>If a computer player is attacked by the cops or another player, it will | |
defend itself if it can, and attempt to run if necessary. During normal | |
play it will also attempt to "blend in" with the other players by hurling | |
-rather pathetic insults at them... you are free to edit the code of the | |
-AI player to give these insults a little more "punch", or | |
-<a href="mailto:[email protected]">email</a> them to me (preferably | |
-without actually directing the insults themselves at me!) and I'll add them | |
-to the next dopewars release.</p> | |
+rather pathetic insults at them... you are free to | |
+<a href="https://github.com/benmwebb/dopewars/blob/develop/src/AIPlayer.c">edit | |
+the code</a> of the AI player to give these insults a little more "punch".</p> | |
<hr /> | |
<ul> | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>15-07-2002</b><br /> | |
+ Last update: <b>05-12-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
</body> | |
diff --git a/doc/contribute.html b/doc/contribute.html | |
t@@ -19,24 +19,24 @@ help out - in fact, dopewars currently needs people to pro… | |
graphics rather than to write code.</p> | |
<ul> | |
-<li><b>Sounds</b> are urgently needed right now. dopewars-1.5.7 and later | |
-support sounds, but at the moment users must supply their own sound files, | |
-as none are included. If <b>you</b> can provide copyright-free sounds, | |
-then short files are needed for various effects in the game. For example, | |
+<li><b>Sounds</b> are needed. dopewars-1.5.7 and later support sounds, but | |
+don't contain sounds for every game event. If <b>you</b> can provide | |
+copyright-free sounds, then short files are needed for various effects | |
+in the game. For example, | |
gunshots, bullet hits, ricochets and subway trains are obvious candidates | |
for sound effects, although pretty much any event in the game that you can | |
think of can conceivably have a sound (e.g. when players join or leave the | |
game). These sounds should be in WAV format, and should probably be no more | |
than a second or two in length. Later versions of dopewars may also be able | |
to play longer repeating sounds (i.e. music) if you're interested in | |
-contributing this. Use the | |
-<a href="http://sourceforge.net/forum/forum.php?forum_id=195965">SourceForge | |
-Data forum</a> to see what sounds other people are working on. | |
+contributing this. Please open a | |
+<a href="https://github.com/benmwebb/dopewars/pulls">pull request</a> | |
+to add sound files to dopewars. | |
<p /></li> | |
<li><b>Suggestions</b> for future improvements are always welcomed at the | |
-<a href="http://sourceforge.net/forum/forum.php?forum_id=34874">SourceForge | |
-Open Discussion forum</a>. These can be anything from "the game interface | |
+<a href="https://github.com/benmwebb/dopewars/issues">issue tracker</a>. | |
+These can be anything from "the game interface | |
is confusing" through "more game locations are needed" to "what about a | |
hospital". (I can't guarantee that such suggestions will ever make it | |
into dopewars, but it's a lot easier if I know they exist! Also, it's | |
t@@ -44,17 +44,17 @@ far more likely to happen if you write the code - see the | |
<a href="developer.html">tips for developers</a> page.)<p /></li> | |
<li><b>Bug reports</b> are always useful. Register them with the | |
-<a href="http://sourceforge.net/tracker/?group_id=11128&atid=111128">Sourc… | |
-bug tracker</a>. If I don't know the problem exists, I can't fix it... | |
+<a href="https://github.com/benmwebb/dopewars/issues">issue tracker</a>. | |
+If I don't know the problem exists, I can't fix it... | |
The more information you can give here, the better. In particular, I need | |
to know your operating system - e.g. Linux or Windows. For Linux, gdb stack | |
traces of the core file are most useful.<p /></li> | |
<li><b>Configuration files</b> can be included in future distributions. If | |
you run a customised game, and think others might want to play with your | |
-configuration, or at least use it as an example, then post it to the | |
-<a href="http://sourceforge.net/forum/forum.php?forum_id=195965">SourceForge | |
-Data forum</a>...<p /></li> | |
+configuration, or at least use it as an example, then post it in the | |
+<a href="https://github.com/benmwebb/dopewars/issues">issue tracker</a>. | |
+<p /></li> | |
<li><b>Translation</b> of dopewars into your language will enable you to | |
play the game in your native tongue, and will also help others that speak | |
t@@ -67,7 +67,7 @@ simple text file! See the <a href="i18n.html">i18n pages</a>… | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>22-07-2002</b><br /> | |
+ Last update: <b>05-12-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
</body> | |
diff --git a/doc/developer.html b/doc/developer.html | |
t@@ -19,10 +19,9 @@ to dopewars development, and so encourage discussion of the… | |
documentation and concept, and particularly welcome suggested improvements.</p> | |
<p>You are free to distribute modified versions of the code, | |
-again subject to the licence, but I also welcome patches to the code at my | |
-email address, | |
-<a href="mailto:[email protected]">[email protected]</a>. | |
-If I choose to include these patches in a new dopewars version, you will of | |
+again subject to the licence, but I also additions to the code | |
+via <a href="https://github.com/benmwebb/dopewars/pulls">pull requests</a>. | |
+If I choose to include this code in a new dopewars version, you will of | |
course be credited in the changelog (unless, of course, you don't want to | |
be).</p> | |
t@@ -34,7 +33,8 @@ documented <a href="protocol.html">here</a>.</p> | |
is the source code itself. It is not exactly "self-documenting", but I have | |
endeavoured to add sufficient documentation to the source where necessary; | |
any discussion here of the internal workings, however, may be incomplete, out | |
-of date, and possibly misleading. Feel free to email me at the address above | |
+of date, and possibly misleading. Feel free to | |
+<a href="https://github.com/benmwebb/dopewars/issues">open an issue</a> | |
with questions on this; I might possibly even know the answers!</p> | |
<hr /> | |
t@@ -42,7 +42,7 @@ with questions on this; I might possibly even know the answe… | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>15-07-2002</b><br /> | |
+ Last update: <b>05-12-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
</body> | |
diff --git a/doc/i18n.html b/doc/i18n.html | |
t@@ -65,15 +65,18 @@ They are simple text files, consisting of lists of the ori… | |
(labelled by "msgid") followed by the translated string (labelled by | |
"msgstr").</p> | |
-<p>Adding a new translation is simply a matter of copying the reference file | |
-<tt>dopewars.pot</tt> to your language-specific <tt>.po</tt> file in the | |
-<tt>po/</tt> directory, and filling in the "msgstr" entries. Once this is done, | |
-edit the <tt>configure.in</tt> file in the top dopewars directory to add your | |
+<p>To add a new translation, first | |
+<a href="installation.html">install dopewars from source code</a>. This will | |
+generate the reference file <tt>dopewars.pot</tt> in the <tt>po</tt> | |
+subdirectory. Then, copy <tt>dopewars.pot</tt> to your language-specific | |
+<tt>.po</tt> file in the | |
+<tt>po/</tt> directory, and fill in the "msgstr" entries. Once this is done, | |
+edit the <tt>configure.ac</tt> file in the top dopewars directory to add your | |
language code to the <tt>ALL_LINGUAS</tt> variable. Then run <tt>autoconf</tt> | |
to rebuild the <tt>configure</tt> script, before making and installing dopewars | |
as usual. The new translation should now be available. Once this is complete, | |
-please <a href="mailto:[email protected]">send</a> the translation to | |
-be included in the next dopewars version.</p> | |
+please <a href="https://github.com/benmwebb/dopewars/pulls">open a pull | |
+request</a> to have the translation included in the next dopewars version.</p> | |
<p>Please note that some strings are <b>format strings</b> containing the % | |
character. These are used in the program code for substituting numbers and | |
t@@ -225,7 +228,7 @@ contributed to the main dopewars distribution!</p> | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>11-05-2006</b><br /> | |
+ Last update: <b>05-12-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
diff --git a/doc/installation.html b/doc/installation.html | |
t@@ -50,17 +50,14 @@ see the <a href="#tarball">tarball installation</a> sectio… | |
see the <a href="windows.html">Windows page</a>.</p> | |
<h2><a id="rpmbinary">RPM binary installation</a></h2> | |
-<p>The binary RPMs are built for Intel (also Intel compatibles, such as AMD, | |
-Cyrix, etc.) systems running RedHat Linux 9. On other systems, these binary | |
-RPMs may refuse to install, or may run but then crash with mysterious | |
-segmentation faults due to library conflicts.</p> | |
+<p>The binary RPMs are built for Intel systems running RedHat or Fedora Linux. | |
+On other systems, these binary RPMs may refuse to install, or may run but then | |
+crash with mysterious segmentation faults due to library conflicts.</p> | |
<ol> | |
<li>Download the | |
<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.12-1.i386.rp… | |
-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.)</li> | |
+i386 (Intel)</a> RPM with your web browser.</li> | |
<li>Become root on your Unix box (if you cannot become root, then you will | |
probably not be able to use RPM installation, depending on how "rpm" is set | |
t@@ -86,7 +83,7 @@ source code RPM</a>.</li> | |
<li>Become root and change to the directory containing the new rpm.</li> | |
<li>Build a binary rpm with the command<br /> | |
-<tt><b>rpm --rebuild dopewars-1.5.12-1.src.rpm</b></tt></li> | |
+<tt><b>rpmbuild --rebuild dopewars-1.5.12-1.src.rpm</b></tt></li> | |
<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@@ -104,13 +101,11 @@ This is also usually a necessity if you cannot become ro… | |
your Unix box, or if you wish to build the Windows version from source code.</… | |
<p>Before beginning, you should ensure that you have all the necessary | |
-prequisites (see above). To compile on a Windows system, you should install | |
-the free <a href="http://sourceware.cygnus.com/cygwin/">Cygwin</a> suite, and | |
-use the included compiler. (You could use a different C/C++ Windows compiler, | |
-but you'll have to write your project files if you do this.) On either Windows | |
-or Unix systems, you will need to get the GLib library first, available for | |
-Unix <a href="http://www.gtk.org/download/">here</a> or for Windows | |
-<a href="http://www.gimp.org/win32/downloads.html">here</a>.</p> | |
+prequisites (see above). To compile on a Windows system, you will need | |
+the MinGW compiler and libraries; see the | |
+<a href="https://github.com/benmwebb/dopewars/tree/develop/win32">Windows-spec… | |
+build page</a> for more information. | |
+</p> | |
<ol> | |
<li>Download the | |
t@@ -124,7 +119,7 @@ with the command <br /> | |
<li>Change into the dopewars-1.5.12 directory, and read all the important | |
documentation in there ;) Most notably, the INSTALL file gives more details | |
-on setup and installation on Windows systems.</li> | |
+on setup and installation.</li> | |
<li>Build the binary with the commands<br /> | |
<tt><b>./configure</b><br /> | |
t@@ -133,11 +128,9 @@ on setup and installation on Windows systems.</li> | |
<li>Become root and install the dopewars files with<br /> | |
<tt><b>make install</b></tt><br /> | |
<p>The configure script will test your system and set up dopewars so that it | |
-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.12 directory.</p> | |
+should compile cleanly. The configure script supports a number of | |
+configurable options; for more details, read the INSTALL file in the | |
+dopewars-1.5.12 directory.</p> | |
<p>If you cannot become root, run the configure script specifying directories | |
for which you have write access for the dopewars files, with a command | |
t@@ -150,7 +143,7 @@ such as<br /> | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>28-07-2003</b><br /> | |
+ Last update: <b>05-12-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
</body> | |
diff --git a/doc/metaserver.html b/doc/metaserver.html | |
t@@ -126,7 +126,7 @@ will automatically replace the "old" one.</p> | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>15-07-2002</b><br /> | |
+ Last update: <b>02-11-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
</body> | |
diff --git a/doc/server.html b/doc/server.html | |
t@@ -60,17 +60,15 @@ communication.) Also, by default the text-mode server send… | |
standard output; you may wish to instead log to a file with the <b>-l</b> | |
option.</p> | |
-<h2><a id="ntservice">Running as an NT service</a></h2> | |
+<h2><a id="ntservice">Running as a Windows service</a></h2> | |
<p>On Windows systems, the graphical server has one major drawback; it can | |
only run while you are logged on. As soon as you log out, the server is | |
-killed. To get around this limitation, dopewars supports being run as an | |
-"NT Service" under Windows NT and later systems (e.g. 2000, XP). The install | |
-program should set up the service; users with suitable access rights can then | |
-start or stop the service via the Control Panel. The disadvantage of the | |
-server in this configuration is that server commands cannot be issued once | |
-the server is running. This limitation should be fixed in a future release | |
-of dopewars.</p> | |
+killed. To get around this limitation, dopewars | |
+<a href="windows.html">supports being run</a> as a "Windows Service". | |
+The disadvantage of the server in this configuration is that server commands | |
+cannot be issued once the server is running. This limitation should be | |
+fixed in a future release of dopewars.</p> | |
<h2><a id="metaserver">Private and public: the dopewars metaserver</a></h2> | |
t@@ -105,7 +103,7 @@ information on getting round these difficulties, see the | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
<p> | |
- Last update: <b>15-07-2002</b><br /> | |
+ Last update: <b>05-12-2020</b><br /> | |
Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a> | |
</p> | |
</body> |