Update of /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21896/resources/htmlhelp/html Modified Files: basics.html commandline.html configfile.html configsyntax.html controlsintro.html dashboard.html defaultmap.html galaxy.html gamecontrols.html generalconfig.html intro.html jointhegame.html loginscreen.html macrosconfig.html mainwindows.html messages.html metaserver.html motdwindow.html playerlist.html plistconfig.html remapping.html serversettings.html tactical.html teamselect.html windowsconfig.html Log Message: Vastly updated the html help, fixing grammar/spelling errors, updating info that needed updating, etc. Index: gamecontrols.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/gamecontrols.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- gamecontrols.html 12 Apr 2006 04:31:03 -0000 1.1 +++ gamecontrols.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,7 +7,7 @@ <body> <h1>Game Controls</h1> <p> -In this section you will learn how to use mouse and keyboard to fly your ship, +In this section you will learn how to use the mouse and keyboard to fly your ship, change options, etc. <p> Section topics: Index: intro.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/intro.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- intro.html 12 Apr 2006 04:31:03 -0000 1.1 +++ intro.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,15 +7,13 @@ <body> <h1>Introduction</h1> <p> -NetrekXP Mod is a client for Netrek - multiplayer battle simulation game. +NetrekXP is a client for Netrek, an online multiplayer space combat game. <bp> -The program is modification of existing client called NetrekXP (yeah, this is -where 'Mod' comes from). All Netrek clients have some similarities and some +The current version of NetrekXP was originally based on an existing client called COW. Work on the NetrekXP client has been done by Steve Sheldon, Stas Pirogov, and Bill Balcerski. All Netrek clients have some similarities and some differences. I would recommend trying each and every one of them before -making decision on what client to play with. +making a decision on what client to play with. <p> -This reference will help you to get familiar with the program, its configurations -and possible customizations. +This help file will let you get familiar with the program and its possible customizations. Help file originally written by Stas Pirogov, modified by Bill Balcerski. <p> Manual Sections: <ul> Index: windowsconfig.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/windowsconfig.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- windowsconfig.html 12 Apr 2006 04:31:03 -0000 1.1 +++ windowsconfig.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,7 +7,7 @@ <body> <h1>Windows Configuration</h1> <p> -First of all let's list names of NetrekXP Mod windows: +First of all let's list the names of the NetrekXP windows: <ul> <li><b>netrek</b> - Main window</li> <li><b>local</b> - Tactical window</li> @@ -22,6 +22,7 @@ <li><b>review_phaser</b> - Window that receives Phaser messages</li> <li><b>planet</b> - Planet list window</li> <li><b>player</b> - Player list window</li> +<li><b>player2</b> - Alternate player list window</li> <li><b>war</b> - War declaration window</li> <li><b>fed</b> - Federation selection window</li> <li><b>ori</b> - Orion selection window</li> @@ -79,11 +80,11 @@ netrek.geometry: 1024x768 - only size parameters<br> netrek.geometry: +0+0 - only placement parameters <p> -Above options can be used with any window. +The above options can be used with any window. <p> -Next option can only be used with message windows: +The next option can only be used with message windows: <p> -<code><b><message window>.allow: [A][T][I][P][K]</b></code> - choose type of messages printed in message window +<code><b><message window>.allow: [A][T][I][P][K]</b></code> - choose what type of messages that are printed in the message window <ul> <li><b>A</b> - All messages</li> <li><b>T</b> - Team messages</li> Index: dashboard.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/dashboard.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- dashboard.html 12 Apr 2006 04:31:03 -0000 1.1 +++ dashboard.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,28 +7,28 @@ <body> <h1>Dashboard</h1> <p> -Dashboard window contains vital ship information and weapons used: +The dashboard window contains vital ship information: <p> <img src="images\dashboard.gif"> <p> -The window is divided roughly in two parts - <b>Flags</b> and <b>Gauges</b> +The window is divided roughly into two parts - <b>Flags</b> and <b>Gauges</b> <p> Let's get familiar with them: <ul> <li>Flags from left to right:</li> <ul> - <li>S - shields on</li> - <li>G/Y/R - flag that shows proxymity alert. G for green, Y - yellow, R - red</li> - <li>L - you are locked on something (player or planet)</li> - <li>R - you are repairing</li> - <li>B - you are bombing</li> - <li>O - you are orbiting planet</li> - <li>D - you are docking startbase (or if you are starbase then docking is enabled)</li> - <li>C - you are cloaked</li> - <li>W - your weapons are hot</li> - <li>E - your engine is hot</li> - <li>P/T - you are pressoring or tractoring somebody</li> - <li>u/d - you are beaming armies up or down</li> + <li>S - shows if your shields are on</li> + <li>G/Y/R - flag that shows proximity alert. G for green, Y - yellow, R - red</li> + <li>L - shows if you are locked on something (player or planet)</li> + <li>R - shows if you are repairing</li> + <li>B - shows if you are bombing</li> + <li>O - shows if you are orbiting a planet</li> + <li>D - shows if you are docking at a starbase (or if you are a starbase, then if docking is enabled)</li> + <li>C - shows if you are cloaked</li> + <li>W - shows if your weapons are hot</li> + <li>E - shows if your engine is hot</li> + <li>P/T - shows if you are pressoring or tractoring somebody</li> + <li>u/d - shows if you are beaming armies up or down</li> </ul> <li>Gauges:</li> <ul> @@ -36,8 +36,8 @@ <li>Sh - shields damage points</li> <li>Da - hull damage points</li> <li>Ar - armies carried</li> - <li>Wt - weapons temperature</li> - <li>Et - egnine temperature</li> + <li>Wt - weapon temperature</li> + <li>Et - engine temperature</li> <li>Fu - fuel available</li> <li>Kills - number of kills</li> </ul> Index: loginscreen.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/loginscreen.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- loginscreen.html 12 Apr 2006 04:31:03 -0000 1.1 +++ loginscreen.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -8,25 +8,25 @@ <h1>Login Screen</h1> <p> After successfull connection to the server you will see the main game window. It is -divided to four parts initially, but we will get familiar with each of them in the -next topics. +divided into four parts initially, but we will get familiar with each of them in the +next topic. <p> -If your client isn't configured to automatically login you to the game you will be +If your client isn't configured to automatically login to the game, you will be asked to supply your username and password to join the game (or observe the game). <p> -The login window is located on the top left of main screen: +The login window is located on the top left of the main screen: <p> <img src="images\loginscreen.gif"> <p> There are two types of logins on most servers - <b>guest user</b> and <b>authenticated user</b>. <p> -If you type "guest" as your name or push Ctrl-g you will not be required to supply password. There are +If you type "guest" as your name or push Ctrl-g you will not be required to supply a password. There are some differences between guest users and authenticated users. The major difference is -that no information is written to the server players database for guests. So when you +that no information is written to the server's player database for guests. So when you disconnect from the game all your statistics are wiped out. <p> -For authenticated users everything is saved to players database, so when you come next -time to the server and supply your name and password you will start the game with statistics +For authenticated users everything is saved to the player database, so when you next come +to the server and supply your name and password, you will start the game with statistics that were saved for you from the last session. </body> </html> \ No newline at end of file Index: macrosconfig.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/macrosconfig.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- macrosconfig.html 12 Apr 2006 04:31:03 -0000 1.1 +++ macrosconfig.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -12,18 +12,18 @@ <li>Regular Macros</li> <li>Receiver Configurable Distress Macros</li> </ul> -The main difference between two is that you send the first type by yourself while second -type is actually how you want other's macros to be showed on your client. +The main difference between the two is that you send the first type by yourself while the second +type is actually how you want other's macros to be shown on your client. <p> In order to trigger any of these you should enter Macro Mode. Some macros are used -by players very frequently, so in order to speedup the process you can use +by players very frequently, so in order to speedup the process you can use the following configuration option: <p> <code><b>singleMacro: <keys list for one-push macros></b></code> <p> Example:<br> <code>singleMacro: FE^q</code> - will allow triggering macros defined for F, E and Ctrl-q -by single key push. +by a single key push. <p> <h2>Regular Macros</h2> Regular macros can be either single or multiline and their general syntax is: @@ -34,7 +34,7 @@ <li> <code><b><key></b></code> - key to press in macro mode to send macro <p> -The key can be in form of: +The key can be in the form of: <ul> <li><b>char</b> - press key on keyboard</li> <li><b>^char</b> - press Ctrl+key on keyboard</li> @@ -51,12 +51,12 @@ <li><code><b>T</b></code> - send to your Team</li> <li><code><b>F</b></code> - send to Federation</li> <li><code><b>K</b></code> - send to Klingons</li> - <li><code><b>O</b></code> - send ti Orions</li> + <li><code><b>O</b></code> - send to Orions</li> <li><code><b>R</b></code> - send to Romulans</li> <li><code><b>a-z</b></code> - send to player</li> <li><code><b>%I, %i, %c</b></code> - send to yourself</li> <li><code><b>%U, %u, %p</b></code> - send to player nearest your mouse pointer</li> - <li><code><b>%Z, %z, %t</b></code> - send to a team whose player nearest your mouse pointer</li> + <li><code><b>%Z, %z, %t</b></code> - send to a team whose player is nearest your mouse pointer</li> <li><code><b>%g</b></code> - send to friendly player nearest your mouse pointer</li> <li><code><b>%h</b></code> - send to enemy player nearest your mouse pointer</li> </ul> @@ -65,7 +65,7 @@ <li> <code><b><macro string></b></code> - text string <p> -In addition to regular text, macro string can contain: +In addition to regular text, the macro string can contain: <ul> <li><code><b>%a</b></code> - armies carried by sender</li> <li><code><b>%d</b></code> - sender damage percentage</li> @@ -141,15 +141,14 @@ <p> <h2>Receiver Configurable Distresses</h2> <p> -As we already told RCD is opposite to the macro. You decide what do display instead of something that was received -from another player. +As we already said, the RCD is the opposite to the macro. You decide what to display instead of something that was received from another player. <p> -There is a limited amount of RCDs because server doesn't actually send any text to you, but instead it tells +There is a limited amount of RCDs because the server doesn't actually send any text to you, but instead it tells your client that player 'x' sent RCD number 'y'. The client then looks what should be displayed when receiving RCD 'y' and creates text that is only displayed in your client. <p> -RCD syntax also defines key that will trigger RCD to be sent to others. The distress text will be shown same -whether you send specific RCD or you receive it from other player: +RCD syntax also defines the key that will trigger a RCD to be sent to others. The distress text will be shown the same +whether you send a specific RCD or you receive it from another player: <p> <code><b>dist.<key>.<distress name>: <distress text></b></code> <ul> @@ -185,6 +184,6 @@ </li> </ul> <p> -All RCDs are predefined by client and can be changed if needed. +All RCDs are predefined by the client and can be changed if needed. </body> </html> \ No newline at end of file Index: messages.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/messages.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- messages.html 12 Apr 2006 04:31:03 -0000 1.1 +++ messages.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -9,21 +9,21 @@ <p> There are roughly 5 types of messages in Netrek: <ul> -<li>All - such message is seen by everyone in game</li> -<li>Team - this message is seen only by team (race) that it was sent to</li> -<li>Individual - this message is only see by person it was sent to</li> -<li>Phaser - this message is sent from GOD (server) to player that used phaser. The message contains statistics information on damage</li> -<li>Kill - this message is sent by GOD (server) to everyone. Every message contains data on who was killed by whom, what kind of weapon caused death and how much credits were earned</li> +<li>All - this message is seen by everyone in game</li> +<li>Team - this message is seen only by the team (race) that it was sent to</li> +<li>Individual - this message is only seen by the person it was sent to</li> +<li>Phaser - this message is sent from GOD (server) to a player that used a phaser. The message contains statistics information on damage</li> +<li>Kill - this message is sent by GOD (server) to everyone. Every message contains data on who was killed by whom, what kind of weapon caused death, and how many kill credits were earned</li> </li> </ul> <p> There are 6 different windows that can be used to see these messages: <ul> -<li>Review - any message is seen there</li> -<li>All - only messages to everyone are seen there</li> +<li>Review - all message are seen there</li> +<li>All - only messages to 'all' are seen there</li> <li>Team - only team messages are seen there</li> <li>Individual - only messages sent to you are seen there</li> -<li>Phaser - phaser messages are see there</li> +<li>Phaser - phaser messages are seen there</li> <li>Kill - only kill messages are seen there</li> </ul> <p> @@ -31,9 +31,9 @@ <p> <img src="images\messages.gif"> <p> -The default client setup is to show only Review window, so all messages your client receives are displayed there. -It is common to argue about best message window setups. Most veterans tend to play with only one Review -window. This way they know exact time flow of messages (with multiple windows it is impossible to find out what message -arrived before or after any given one). +The default client setup may only show the Review window, so all messages your client receives are displayed there. +It is common to hear people argue about the best message window setups. Most veterans tend to play with only one Review window. This way they know the exact time flow of messages (with multiple windows it is impossible to find out what message arrived before or after any given one). +For advanced users, there is a way to modify which sort of messages are sent to which window. +See <a href="windowsconfig.html">Windows Configuration</a> for more details. </body> </html> \ No newline at end of file Index: playerlist.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/playerlist.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- playerlist.html 12 Apr 2006 04:31:03 -0000 1.1 +++ playerlist.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,17 +7,17 @@ <body> <h1>Player List</h1> <p> -Player list window contains information on players in the game. +The player list window contains information on players in the game. <p> <img src="images\playerlist.gif"> <p> -The window contains both players and observers, but can be configured to display only part of the at a time. +The window can contain both players and observers, but it can be configured in many ways to fit your choosing. <p> -Today servers allow 32 players to exist in game - half playing, half observing. It is easy to see players from -observers by looking at their player number (letter). Anyone below hexadecimal 'f' (15) will be player, others are +Todays servers allow 32 players maximum to exist in game - half playing, half observing. It is easy to tell players from +observers by looking at their player number (letter). Anyone below hexadecimal 'f' (15) will be a player, the others are observers. <p> The list contains useful information on other players, such as their name and login, statistics, hours spent playing, etc. -You will get familiar with all details after some time of playing. +You will get familiar with all the details after some time of playing. </body> </html> \ No newline at end of file Index: configfile.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/configfile.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- configfile.html 12 Apr 2006 04:31:03 -0000 1.1 +++ configfile.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,11 +7,11 @@ <body> <h1>Configuration File</h1> <p> -Any of program configuration options can be saved in configuration file. This -way after finding all valuable settings for you it is easy to automatically load -them when you fire up the client to play another game. +Any of your program configuration options can be saved in a configuration file. This +way, after taking the time to choose your favorite settings, they are automatically loaded +when you fire up the client to play another game. <p> -NetrekXP Mod searches for following files (in order from top to bottom) in the +NetrekXP searches for following files (in order from top to bottom) in the executable directory: <p> <ul> @@ -20,7 +20,7 @@ <li><b>xtrekrc</b></li> <li><b>xtrekrc.txt</b></li> </ul> -So if you have one of these file it will be read at startup and change application +So if you have one of these files it will be read at startup and the change application defaults to whatever values set in the configuration file. <p> Section topics: Index: mainwindows.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/mainwindows.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- mainwindows.html 12 Apr 2006 04:31:03 -0000 1.1 +++ mainwindows.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,11 +7,11 @@ <body> <h1>Main Game Windows</h1> <p> -Congratulations, Captain. You sucessfully joined Netrek Universe: +Congratulations, Captain. You have successfully joined the Netrek Universe: <p> <img src="images\mainwindows.gif"> <p> -Next topics will give you short explanation about windows that compose it: +The next topics will give you a short explanation about the windows that compose the game: <ul> <li><a href="tactical.html">Tactical (Local) Window</a></li> <li><a href="galaxy.html">Galaxy (Map) Window</a></li> Index: generalconfig.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/generalconfig.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- generalconfig.html 12 Apr 2006 04:31:03 -0000 1.1 +++ generalconfig.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,7 +7,7 @@ <body> <h1>General Configuration Options</h1> <p> -Following table contains all possible general configuration options and their defaults: +The following table contains all possible general configuration options and their defaults: <table border=1 cellspacing=0 cellpadding=3> <tr> <td><b>Name</b></td> @@ -36,6 +36,16 @@ </td> </tr> <tr> +<td><code><b>allowWheelActions</b></code</td> +<td>Enable mouse wheel in non-scrolling window</td> +<td> + <ul> + <li><b>on (default)</b> - owner race color</li> + <li><b>off</b> - white</li> + </ul> +</td> +</tr> +<tr> <td><code><b>autoQuit</b></code></td> <td>Autoquit timer</td> <td><b>integer</b><br>default: 60</td> @@ -112,18 +122,26 @@ <td><b>color name</b></td> </tr> <tr> +<tr> +<td><code><b>color.<race></b></code></td> +<td>Replace <race> with value</td> +<td><b>color name</b></td> +</tr> +<tr> <td><code><b>colorClient</b></code></td> -<td>type of bitmaps to load on startup</td> +<td>type of bitmaps to use on startup</td> <td> <ul> <li><b>0</b> - monochrome bitmaps</li> - <li><b>1 (default)</b> - color bitmaps</li> + <li><b>1 (default)</b> - new color bitmaps</li> + <li><b>2</b> - old color bitmaps</li> + <li><b>3</b> - shaded old color bitmaps</li> </ul> </td> </tr> <tr> <td><code><b>colorfulPhasers</b></code></td> -<td>Display Jubilee phasers</td> +<td>make your phasers multicolored</td> <td> <ul> <li><b>on</b></li> @@ -570,7 +588,12 @@ </tr> <tr> <td><code><b>playerList</b></code></td> -<td>Player list manual style</td> +<td>Player list custom layout</td> +<td><b>string</b></td> +</tr> +<tr> +<td><code><b>playerList2</b></code></td> +<td>Alternate Player list custom layout</td> <td><b>string</b></td> </tr> <tr> Index: galaxy.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/galaxy.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- galaxy.html 12 Apr 2006 04:31:03 -0000 1.1 +++ galaxy.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,27 +7,27 @@ <body> <h1>Galaxy Window</h1> <p> -Galaxy or Map is the window where you will collect very useful information on -what the hell is happening here. +The Galaxy, or Map, window is where you will collect very useful information on +what the hell is happening across the entire map. <p> -This is a picture of the whole galaxy. All planets have fixed location -(though there is a server setting that allows galaxy to rotate). The only resourse -that doesn't change from game to game is the planet name, so try to remember planet +This is a picture of the whole galaxy. All planets have a fixed location +(though there is a server setting that allows the galaxy to rotate). The only resource +that doesn't change from game to game is the planet name, so try to remember the planet names. This will be very useful. <p> <img src="images\galaxy.gif"> <p> -Every planet can be owned by one of four races or can be independent. -The ownership of the planet is defined by armies the planet has. If there are -Romulan armies on it then it is owned by Romulan Empire. The ownership of the planet +Every planet can be owned by one of the four races, or it can be independent. +The ownership of the planet is defined by the armies the planet has. If there are +Romulan armies on it then it is owned by the Romulan Empire. The ownership of the planet can be changed by dropping your armies on enemy planets. 1 army kills 1 enemy army. -When you kill all enemy armies the planet becomes not owned by anyone and thus can +When you kill all enemy armies, the planet becomes not owned by anyone (independent) and thus can be taken. <p> Initially only your team planets are visible (i.e. have resources like fuel/repair/agri visible when you try to get info on planet). Other planets are grayed out and you can't -get any information on them. In order for planet to become visibile to your team one -of team players should orbit it. +get any information on them. In order for a planet to become visibile to your team, one +of your team's players should orbit it. <p> </body> </html> \ No newline at end of file Index: basics.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/basics.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- basics.html 12 Apr 2006 04:31:03 -0000 1.1 +++ basics.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,7 +7,7 @@ <body> <h1>The Basics</h1> <p> -This section will give you short introduction on client look and feel.<br> +This section will give you a short introduction on client look and feel.<br> You will also find some useful information on how to use different windows. <p> Section topics: Index: metaserver.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/metaserver.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- metaserver.html 12 Apr 2006 04:31:03 -0000 1.1 +++ metaserver.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,23 +7,23 @@ <body> <h1>Metaserver Window</h1> <p> -This will probably be the first window you will see starting the client. -The window appears after successfull connection to metaserver that -holds list of available netrek servers. +This will probably be the first window you will see after starting the client. +The window appears after successful connection to a metaserver that +holds the list of available netrek servers. <p> Here is how it looks: <p> <img src="images/metawindow.gif"> <p> -There are several types of games played in Netrek Universe. It could be Bronco, -Hockey, Chaos, Dogfight and some others. Most of servers you'll see these days +There are several types of server settings, such as Bronco, +Hockey, and Chaos. Most of the servers you'll see these days are either Bronco or Hockey. Bronco is the most popular type of Netrek, so go on and click on some Bronco server to connect to the game. <p> In order to join the game to play you should point on one of the servers and click -<b>left</b> mouse button.<br> -If you wish to observe the game instead of playing - click <b>right</b> mouse button. +the <b>left</b> mouse button.<br> +If you wish to observe the game instead of playing - click the <b>right</b> mouse button. <p> -Clicking on one of yellow links will open your browser on the link's main site +Clicking on one of the yellow links will open your browser to the specified website. </body> </html> \ No newline at end of file Index: teamselect.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/teamselect.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- teamselect.html 12 Apr 2006 04:31:03 -0000 1.1 +++ teamselect.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,24 +7,24 @@ <body> <h1>Team Selection</h1> <p> -Right below MOTD window you have Team (Race) Selection part: +Right below the MOTD window you have the Team (Race) Selection part: <p> <img src="images\teamselect.gif"> <p> -There are four races exist in Netrek - Federation, Romulans, Klingons and Orions +There are four races in Netrek - Federation, Romulan, Klingon and Orion. <p> -Each of the races has different ship pictures (though the ships have exactly same +Each of the races has different ship pictures (though the ships have exactly the same power and weapons among the races). <p> -In the races selection you will see number of players playing per-race. If there is -a T-mode you will only be allowed to join one of the two playing races. Otherwise you +In the race selection boxes you will see the number of players playing per race. If there is +T-mode you will only be allowed to join one of the two main playing races. Otherwise you are allowed to select at least one of three teams. <p> -In order to select team you should do one of two: +In order to select team you should do one of two things: <ul> -<li>click with left mouse button on the team box. This will make you join the team in default ship -that is defined for client</li> -<li>point with mouse at the team box and press one of the following keys to select one of the ship +<li>click with the left mouse button on the team box. This will make you join the team in the default ship +that is defined for your client (cruiser unless you change it)</li> +<li>point with the mouse at the team box and press one of the following keys to select one of the ship types: <ul> <li><b>s</b> - Scout (SC)</li> @@ -38,8 +38,8 @@ <p> If you want to quit - click on the clock box. <p> -After death you will be presented same team selection window. If you want to change your -team or ship you should use explanation above. However if you want to get back to same team -in the same ship you can push <b>'space'</b> button and you are back. +After death you will be presented the same team selection window. If you want to change your +team or ship you should use the explanation above. However if you want to get back to same team +in the same ship you can push the <b>'spacebar'</b> and you are back. </body> </html> \ No newline at end of file Index: plistconfig.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/plistconfig.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- plistconfig.html 12 Apr 2006 04:31:03 -0000 1.1 +++ plistconfig.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,9 +7,9 @@ <body> <h1>Player List Configuration</h1> <p> -Player list can be configured to show custom columns +The player list can be configured to show custom columns <p> -Syntax for playerList option is as follows: +Syntax for playerList options is as follows: <p> <code><b>playerList: <string of columns></b></code> <p> @@ -48,5 +48,10 @@ <p> <code>playerList: nTRNKWLr O D d</code> - Old style<br> <code>playerList: nTK RNlr Sd</code> - Kill watch style<br> +<p> +In addition it is possible to configure an alternate player list to be able to +view more data than the default player list allows.<br> +The option to configure the alternate player list is <code><b>playerList2</b></code><br> +The syntax is the same as for <code><b>playerList</b></code><br> </body> </html> \ No newline at end of file Index: tactical.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/tactical.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- tactical.html 12 Apr 2006 04:31:03 -0000 1.1 +++ tactical.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,9 +7,9 @@ <body> <h1>Tactical Window</h1> <p> -Tactical or Local is the window where you will have most of fun in Netrek.<br> -It is on the top left of the main screen. Your ship is always centered in it and probably looks tainted by your team color over -white. +The Tactical, or Local, window is where all the action takes place.<br> +It is on the top left of the main screen. Your ship is always centered in it, and probably looks white - though depending +on what bitmaps you are using, it can appear colored as well. <p> <img src="images\tactical.gif"> <p> Index: controlsintro.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/controlsintro.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- controlsintro.html 12 Apr 2006 04:31:03 -0000 1.1 +++ controlsintro.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,30 +7,28 @@ <body> <h1>Introduction To Game Controls</h1> <p> -You will need both mouse and keyboard to fully control the game. +You will need both the mouse and keyboard to fully master control of your ship and the game. <p> There are several keys that you probably want to learn in order to control the main window: <br> <ul> -<li><b>Alt+Enter</b> - toggle title bar of client window. This gives you an option to -quickly see what server you are playing on in case of multiple netrek windows are -opened</li> -<li><b>Alt+End</b> - minimize current netrek window</li> -<li><b>Shift+Esc</b> - kill the client really fast. This will not perform any cleanup -procedures, so please, don't use this to logout</li> +<li><b>Alt+Enter</b> - toggles the title bar of client window. This gives you an option to +quickly see what server you are playing on in case multiple netrek windows are +open. It also allows one to quickly minimize the client window</li> +<li><b>Alt+End</b> - another way to minimize the client window</li> </ul> <p> -And now let's discuss main game controls: +And now let's discuss the main game controls: <h2>Mouse</h2> <p> -Let's leave mouse buttons aside for a while and discuss only mouse pointer.<br> -First of all the client will behave absolutely identical in <a href="tactical.html"> -Tactical</a> and <a href="galaxy.html">Galaxy</a> windows.<br> -No matter where you point in one of the windows your client will take mouse -coordinates relative to your ship and depending on command you submitted will process it. +Let's leave mouse buttons aside for awhile and discuss only the mouse pointer.<br> +First of all the client will behave absolutely the same in either the <a href="tactical.html"> +Tactical</a> or <a href="galaxy.html">Galaxy</a> windows.<br> +No matter where you point in one of the windows, your client will take mouse +coordinates relative to your ship and depending on the command you submitted, will process it. <p> -The main purpose of mouse is to add coordinates to every action that you want to +The main purpose of the mouse is to add coordinates to every action that you want to perform. <p> For instance if you want to shoot (left mouse button or 't' on keyboard) the torps @@ -46,20 +44,20 @@ <p> It is possible to change defaults by remapping (reassigning) mouse buttons to different actions. It is also possible to use button clicks in conjunction with Ctrl+Shift, Ctrl or Shift keys. -We will discuss all of these in <a href="remapping.html">Changing Defaults</a> section. +We will discuss all of these in the <a href="remapping.html">Changing Defaults</a> section. <p> <h2>Keyboard</h2> <p> -Well, there is nothing special about keyboard in Netrek. It behaves exactly same as -in any other application. You press key and something happens. +Well, there is nothing special about keyboard in Netrek. It behaves exactly the same as +in any other application. You press a key and something happens. <p> -The only thing you should remember when dealing with keyboard is that every action +The only thing you should remember when dealing with the keyboard is that every action (well, almost every one) will use your mouse pointer coordinates to complete. So when you want to kill someone you should use your mouse to point at him and only then press -your favorit weapon key to shoot. +your favorite weapon key to shoot. <p> Technically there are default bindings for keys in Netrek, but I will not list all -of them here. You can check them under <a href="defaultmap.html">Default Bindings</a> +of them here. You can check them under the <a href="defaultmap.html">Default Bindings</a> section. </body> </html> \ No newline at end of file Index: jointhegame.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/jointhegame.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- jointhegame.html 12 Apr 2006 04:31:03 -0000 1.1 +++ jointhegame.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,11 +7,11 @@ <body> <h1>Joining The Game</h1> <p> -After successfull login you will be presented following window: +After successful login, you will be presented with the following window: <p> <img src="images\jointhegame.gif"> <p> -Next topics will give you short explanation about windows that compose it: +The next topics will give you a short explanation about the windows that compose it: <ul> <li><a href="motdwindow.html">Message Of The Day</a></li> <li><a href="serversettings.html">Server Settings</a></li> Index: serversettings.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/serversettings.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- serversettings.html 12 Apr 2006 04:31:03 -0000 1.1 +++ serversettings.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,31 +7,31 @@ <body> <h1>Server Settings</h1> <p> -The top right part of the main screen after successfull login will contain -server settings. These settings define what type of server it is, whether RSA -client is required to play a game there, how much players it is required to +The top right part of the main screen after successful login will contain the +server settings. These settings define what type of server it is, whether a RSA +client is required to play a game there, how many players are required to start Tournament mode (T-mode), etc. <p> -Here is settings window from pickled.psychosis.net: +Here is the settings window from pickled.psychosis.net: <p> <img src="images\serversettings.gif"> <p> Here is a list of options with brief explanations: <ul> <li>Binary verification - whether the client binary should support some kind of verification</li> -<li>Tournament mode - how much players per side are required to start T-mode</li> +<li>Tournament mode - how many players per side are required to start T-mode</li> <li>Ships allowed - what types of ships are allowed to play on this server</li> <li>Tractor/Pressor beams - whether tractor/pressor beams are allowed on the server</li> -<li>Kill required for plasma - how much kills should you have in order to get plasma after refit</li> -<li>Rank required for SB - what minimum rank should you have to be able to refit to Starbase</li> -<li>Planets required for SB - what minimum number of planets your team owns is required to be able to get Starbase</li> -<li>Hidden mode - when server will hide your enemies in the fog of war</li> -<li>Multiple Entry Planets - whether ships can be respawned no only around their home planet</li> +<li>Kill required for plasma - how many kills you need in order to get plasma after refit</li> +<li>Rank required for SB - what the minimum rank is to be able to refit to a Starbase</li> +<li>Planets required for SB - what your team's minimum number of planets is to build a Starbase</li> +<li>Hidden mode - when the server will hide your enemies in the fog of war</li> +<li>Multiple Entry Planets - whether ships can be respawned only around their home planet</li> <li>Chaos mode - whether chaos mode is enabled or not</li> -<li>Hunter Killer - whether server will send Hunter Killer bot every half hour to clean galaxy</li> +<li>Hunter Killer - whether server will send a Hunter Killer bot every half hour to clean the galaxy</li> <li>Message to GOD log - whether messages to GOD are saved</li> -<li>SB Transwarp - whether players can transwarp to Starbase ship</li> -<li>Surrender Counter - how much planets on loosin team are required to start surrender counter</li> +<li>SB Transwarp - whether players can transwarp to Starbases</li> +<li>Surrender Counter - how few planets the losing team must have to trigger the surrender counter</li> </ul> </body> </html> \ No newline at end of file Index: defaultmap.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/defaultmap.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- defaultmap.html 12 Apr 2006 04:31:03 -0000 1.1 +++ defaultmap.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -80,6 +80,7 @@ <b>U</b> - show rankings window <b>m</b> - message window zoom <b>/</b> - toggle sorted player list + <b>A</b> - toggle alternate player list window <b>:</b> - toggle messages recording to log file <b>+</b> - toggle UDP options window <b>~</b> - toggle sound control window @@ -99,10 +100,10 @@ <p> <h2>Mouse Bindings</h2> <p> -All mouse clicks are translated to keyboard actions. If one of Ctrl, Shift, Ctrl+Shift keys -pressed along with mouse click it will also generate keyboard action. +All mouse clicks are translated to keyboard actions. If one of Ctrl, Shift, or Ctrl+Shift keys +are pressed along with a mouse click, it will also generate a keyboard action. <p> -Next table will list all possible mouse buttons and the keyboard actions they generate: +The next table will list all possible mouse buttons and the keyboard actions they generate: <table border=1 cellspacing=0 cellpadding=3> <tr> <td><b>Mouse Button</b></td> @@ -190,8 +191,8 @@ </tr> </table> <p> -<b>Fourth</b> and <b>Fifth</b> are so called <b>X Buttons</b> that Microsoft added to their +The <b>Fourth</b> and <b>Fifth</b> are so called <b>X Buttons</b> that Microsoft added to their IntelliPoint mouses. You can use IntelliPoint drivers to map them to keys, but instead -of doing that you can just use regular <b>buttonmap</b> in NetrekXP Mod +of doing that you can just use the regular <b>buttonmap</b> in NetrekXP </body> </html> \ No newline at end of file Index: commandline.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/commandline.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- commandline.html 12 Apr 2006 04:31:03 -0000 1.1 +++ commandline.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,17 +7,17 @@ <body> <h1>Command Line Options</h1> <p> -Most of times you will not use command line to start client. +Most of the time you will not use the command line to start the client. However it is handy to remember -h and -p options, so you will be able -to connect to server even when something is wrong with metaserver (which happens -from time to time). Or for instance the server you want to connect to +to connect to a server even when something is wrong with the metaserver (which happens +from time to time). Or, for instance, if the server you want to connect to doesn't report itself to metaserver (so it won't appear in the metaserver window). <p> It is good to remember that default ports for most of servers are 2592 for players and 2593 for observers. So if you want to observe game on continuum.us.netrek.org you will use "netrek -h continuum.us.netrek.org -p 2593". <p> -Here is the list of command options for NetrekXP Mod:<br> +Here is the list of command options for NetrekXP:<br> <br> <pre> -h <server> : specify server name to connect to Index: configsyntax.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/configsyntax.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- configsyntax.html 12 Apr 2006 04:31:03 -0000 1.1 +++ configsyntax.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,21 +7,21 @@ <body> <h1>Configuration File Syntax</h1> <p> -Configuration file is regular text file that can contain comments, empty lines and +The configuration file (often refered to as the netrekrc) is a regular text file that can contain comments, empty lines and configuration definitions. <p> <h2>Comments</h2> <p> -Every line that has hashmark (<b>#</b>) as its first character is comment line and +Every line that has hashmark (<b>#</b>) as its first character is a comment line and will be ignored. <p> <h2>Configuration Options</h2> <p> -The general syntax for any of configuration options is: +The general syntax for any of the configuration options is: <p> <code><b>keyword: <value></b></code> <p> -All configuration option keywords are <b>case incensitive</b> +All configuration option keywords are <b>case insensitive</b> <p> Most of option keywords can have three additional suffixes to enable fine tuning of options: @@ -29,36 +29,36 @@ <ul> <li> <code><b>keyword.observer: <value></b></code> - this suffix will enable -option only in case you are logged in to server as observer +the option only when you are logged in as an observer <p> Example: <br> -<code>buttonmap.observer: 1l2I3i</code> - will set different buttonmap when you +<code>buttonmap.observer: 1l2I3i</code> - will set a different buttonmap when you observe game </li> <p> <li><code><b>keyword.<servernick>: <value></b></code> - this suffix will -set option only if you are connected to server <servernick> +set the option only if you are connected to server <servernick> <p> Note that in order to define <servernick> you should define <b><code>server.<servernick>: <server host name></code></b> <p> Example: <br> -<code>server.continuum: continuum.us.netrek.org</code> - this option sets -servernick for continuum.us.netrek.org to be continuum +<code>server.continuum: continuum.us.netrek.org</code> - this option sets the servernick +for continuum.us.netrek.org to be continuum <br> -<code>keymap.continuum: a2d%</code> - this option defines custom keymap for -server with 'continuum' as its servernick +<code>keymap.continuum: a2d%</code> - this option defines a custom keymap for +a server with 'continuum' as its servernick </li> <p> <li><code><b>keyword.<servertype>: <value></b></code> - this suffix will -set option only if you are connected to server with <servertype> type. +set the option only if you are connected to server with <servertype> type. <p> -Note: the client will automatically set <servertype> only if you connect from <a href="metaserver.html">Metaserver Window</a> +Note: the client will automatically set <servertype> only if you connect from the <a href="metaserver.html">Metaserver Window</a> <p> -If you want to define <servertype> for specific server that is not there or -you connect to server from command line you can use <b><code>servertype.<servernick>: <type of server></code></b> where +If you want to define <servertype> for a specific server that is not there or +you connect to a server from the command line, you can use <b><code>servertype.<servernick>: <type of server></code></b> where <type of server> can be one of following: <ul> <li><code>paradise</code></li> @@ -72,13 +72,13 @@ <p> Example: <br> -<code>server.continuum: continuum.us.netrek.org</code> - this will set servernick +<code>server.continuum: continuum.us.netrek.org</code> - this will set the servernick for continuum.us.netrek.org to be continuum <br> -<code>serverType.continuum: bronco</code> - this will set servertype for continuum +<code>serverType.continuum: bronco</code> - this will set the servertype for continuum to be bronco <br> -<code>keymap.bronco: a2d%</code> - this will set keymap for any bronco server +<code>keymap.bronco: a2d%</code> - this will set the keymap for any bronco server </li> </ul> <p> @@ -111,9 +111,9 @@ Examples: <p> <ul> -<li><code>keepPeace: on</code> - will enable keepPeace option</li> -<li><code>planetBitmap: 2</code> - will assign value of 2 to planetBitmap option</li> -<li><code>buttonmap: 1t2p3k</code> - will assign string '1t2p3k' to buttonmap option</li> +<li><code>keepPeace: on</code> - will enable the keepPeace option</li> +<li><code>planetBitmap: 2</code> - will assign value of 2 to the planetBitmap option</li> +<li><code>buttonmap: 1t2p3k</code> - will assign string '1t2p3k' to the buttonmap option</li> </ul> </body> </html> \ No newline at end of file Index: motdwindow.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/motdwindow.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- motdwindow.html 12 Apr 2006 04:31:03 -0000 1.1 +++ motdwindow.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,15 +7,15 @@ <body> <h1>Message Of The Day</h1> <p> -Top left part of the Team Selection window is called Message Of The Day -or MOTD. This window contains whatever information server administrator (GOD) -decided to display. +The top left part of the Team Selection window is called the Message Of The Day, +or MOTD. This window contains whatever information the server administrator (GOD) +has decided to display. <p> <img src="images\motdwindow.gif"> <p> -You can scroll text in the window using <b>'f', 'b', 'F', 'B'</b> keys to scroll -one line forward, one line backward, one page forward, one page backward. +You can scroll the text in the window using <b>'f', 'b', 'F', 'B'</b> keys to scroll +one line forward, one line backward, one page forward, or one page backward. <p> -You can also press <b>'R'</b> to send statistics reset request to server. +You can also press <b>'R'</b> to send a statistics reset request to server. </body> </html> \ No newline at end of file Index: remapping.html =================================================================== RCS file: /cvsroot/netrek/client/netrekxp/resources/htmlhelp/html/remapping.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- remapping.html 12 Apr 2006 04:31:03 -0000 1.1 +++ remapping.html 21 Apr 2006 11:37:05 -0000 1.2 @@ -7,40 +7,40 @@ <body> <h1>Changing Defaults</h1> <p> -In order to change default buttons and keys bindings you should be familiar -with <a href="configfile.html">Configuration File</a> and be able to edit +In order to change the default buttons and keys bindings you should be familiar +with the <a href="configfile.html">Configuration File</a> and be able to edit it. <p> -It is possible to change keyboard mappings in game by going to help window ('h' in -default keymap) and remapping keys by pointing on desired action and pushing key that +It is possible to change keyboard mappings in game by going to the help window ('h' in +default keymap) and remapping keys by pointing on a desired action and pushing the key that you want this action to be bound to. The main problem with that is that these remappings -are not saved anywhere (unless you save them using "Save options" action) and will be +are not saved anywhere (unless you save them using the "Save options" menu option) and will be lost after you close the program. <p> -There are three configuration commands that deal with keyboard and mouse buttons +There are three configuration commands that deal with keyboard and mouse button rebinding (remapping): <ul> -<li><b>keymap</b> - allows to change keyboard default bindings</li> -<li><b>buttonmap</b> - allows to change mouse default bindings</li> -<li><b>ckeymap</b> - allows to change Ctrl+Key keyboard bindings</li> +<li><b>keymap</b> - allows one to change keyboard default bindings</li> +<li><b>buttonmap</b> - allows one to change mouse default bindings</li> +<li><b>ckeymap</b> - allows one to change Ctrl+Key keyboard bindings</li> </ul> <p> <h2>Syntax</h2> <p> Same syntax is applied for all of the configuration commands above: <p> -<code>command: [<key to bind><action to perform>]+</code> +<code>command: [<key to bind><action to perform>]</code> <p> Examples: <p> <ul> -<li><code>keymap: a2d%</code> - will bind warp 2 speed to key 'a' and maxwarp to key 'b'.</li> -<li><code>buttonmap: 1i3l</code> - will bind info action to mouse button 1 (left button) and -lock action to mouse button 3 (right button).</li> -<li><code>ckeymap: ^cc^vl</code> - will bind cloak action to Ctrl-c and lock action to Ctrl-v</li> +<li><code>keymap: a2b%</code> - will bind warp 2 speed to key 'a' and maxwarp to key 'b'.</li> +<li><code>buttonmap: 1i3l</code> - will bind the info key to mouse button 1 (left button) and +the lock key to mouse button 3 (right button).</li> +<li><code>ckeymap: ^cc^vl</code> - will bind the cloak key to Ctrl-c and the lock key to Ctrl-v</li> </ul> <p> -<code><b>buttonmap</b></code> is the tricky one because you should know what button gets what name. +The <code><b>buttonmap</b></code> is the tricky one because you should know what button gets what name. <br> So here is a table that will list all possible buttons that can be bound there: <table border=1 cellspacing=0 cellpadding=3> @@ -139,7 +139,7 @@ </tr> </table> <p> -For example <code><b>'buttonmap: 1p4dhi'</b></code> - will create following mapping: +For example <code><b>'buttonmap: 1p4dhi'</b></code> - will create the following mapping: <p> <ul> <li><b>Left Mouse Button</b> will map to <b>phaser</b></li> @@ -147,8 +147,8 @@ <li><b>Ctrl+Fifth Mouse Button</b> will map to <b>info</b></li> </ul> <p> -Almost all players at some point will remap (rebind) default keyboard (and probably mouse) actions -to keys that satisfy their requirements. Feel free to play with key bindings and try to get most +Almost all players at some point will remap (rebind) the default keyboard (and probably mouse) actions +to keys that satisfy their requirements. Feel free to play with key bindings and try to get the most out of it. Just remember that once you got used to some specific layout it will be difficult to switch to something else. </body>