Skip to content

Commit

Permalink
Update README.md (#3135)
Browse files Browse the repository at this point in the history
  • Loading branch information
psypherium authored Mar 8, 2023
1 parent 2ab6c37 commit 44cf33e
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 53 deletions.
86 changes: 43 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Warzone 2100
Origins
-------

Warzone 2100, released in 1999 and developed by Pumpkin Studios, was a
Warzone 2100, released in 1999 and developed by Pumpkin Studios, is a
ground-breaking and innovative 3D real-time strategy game.

In 2004 Eidos, in collaboration with Pumpkin Studios, decided to release
Expand All @@ -19,8 +19,8 @@ State of the game
After the liberation of the Warzone 2100 source-code on December 6th, 2004, all
proprietary technologies have been replaced with open-source counterparts.

Right now supported platforms are Linux, Windows, and macOS. There are reports
that Warzone 2100 is working on BSD, too.
Currently, the supported platforms are Linux, Windows, and macOS. There are reports
that Warzone 2100 is also working on BSD.

Installation
------------
Expand Down Expand Up @@ -101,8 +101,8 @@ Reporting bugs
--------------

This game still has bugs and if you run into one, please use the GitHub bugtracker
(https://github.com/Warzone2100/warzone2100/issues) to report this bug. In order to faster fix
those bugs we require that you follow these rules:
(https://github.com/Warzone2100/warzone2100/issues) to report the bug. In order to fix
those bugs more quickly, we require that you follow these rules:

1. If the game crashes you may save a memory dump. Please do so and upload it
when reporting the bug. (Linux locates that file at /tmp/warzone2100.gdmp,
Expand All @@ -111,36 +111,36 @@ those bugs we require that you follow these rules:
A self created backtrace is just as useful.
2. Give as much information about what you were doing before the crash/bug
occurred.
3. Try to reproduce the bug and add a description of the process to your bug-
3. Try to reproduce the bug and add a description of the process to your bug
report.
4. You may even upload save-games. These consist of one or two file(s) and
one folder. All two/three are named after your save-game (e.g.
4. You may even upload save files. These consist of one or two file(s) and
one folder. All two/three are named after your savegame (e.g.
MySaveGame.es, MySaveGame.gam and the folder MySaveGame).
5. Bug-reports are not submit-and-forget. It may be that you forgot some
information or forgot to upload a file. So it is, too, in your interest to
watch the bug-report after it has been submitted. Additionally you receive
e-mails of comments to your bug-report.
5. Bug reports are not submit-and-forget. It may be that you forgot some
information or forgot to upload a file. So it is also in your interest to
watch the bug-report after it has been submitted. Additionally, you can enable
e-mails of comments to your bug report.

Configuration
-------------

Warzone 2100 uses an own sub-directory in a user's home directory to save
configuration data, save-games and certain other things. Additionally you can
Warzone 2100 uses its own subdirectory in a user's home directory to save
configuration data, save files and certain other things. Additionally you can
use this directory to place custom maps and mods so the game can find them. The
location of this directory depends on the operating system.

### Warzone 2100 directory under GNU/Linux

Under GNU/Linux, Warzone 2100 conforms to the [XDG base directory spec](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html).

By default, the directory `warzone2100-<version>` can be found in your home-directory
By default, the directory `warzone2100-<version>` can be found in your home directory
under the path `~/.local/share/`.
(If the `XDG_DATA_HOME` environment variable is defined, the Warzone 2100 folder will
be located within `$XDG_DATA_HOME`.)

The leading dot in the `.local` part of the path indicates that it is a hidden
directory, so depending on your configuration you may not be able to see it.
However, you can still access it by typing the path into your address-bar.
However, you can still access it by typing the path into your address bar.

### Warzone 2100 directory under Windows

Expand All @@ -160,7 +160,7 @@ will browse to your Warzone 2100 directory.

### Warzone 2100 directory under macOS

The directory `Warzone 2100 <version>` can be found in your home-directory at:
The directory `Warzone 2100 <version>` can be found in your home directory at:
`~/Library/Application Support/`

By default, recent version of macOS hide your account's Library folder. To view it in
Expand All @@ -171,7 +171,7 @@ will appear as a menu choice.

The configuration file is just called 'config' and contains several configuration
options, some of them can be changed by using command-line options or using
the in-game menus, others can only be changed by editing the file by hand.
the in-game menus, others can only be changed by editing the file manually.

If at any point you did something wrong, you can delete the old configuration
file and just restart Warzone 2100. Then the game will regenerate a new
Expand All @@ -187,45 +187,45 @@ Notes: These options all have two dashes (--), not one dash only (-). Also,
if the option has an argument, you need to separate the option and its argument
with a '=' sign - spaces do not work.

Note: Some options have corresponding entries in the configuration-file and will
Note: Some options have corresponding entries in the configuration file and will
persist from one start of Warzone 2100 to the next.

Multiplaying via internet
-------------------------

There are two methods to start a multiplayer-game via internet: using the host's
IP or using the lobby-server. Make sure to be able to communicate on TCP-ports
There are two methods to start a multiplayer game via the internet: using the host's
IP or using the lobby server. Make sure you are able to communicate on TCP ports
2100 and 9999. Note that for port forwarding, you only need to configure your
router to forward port 2100.

You can choose whether to connect via Lobby or IP:

* If you choose IP, Warzone 2100 asks you for the ip-address of the host and
* If you choose IP, Warzone 2100 asks you for the IP address of the host and
will try to connect to that IP.
* If you choose Lobby, Warzone 2100 will connect to the lobby server, as long as
the lobby-server-address in your config-file has not been changed.
the lobby-server-address in your config file has not been changed.

You will see a list of games from which you can select one.
You will see a list of games from which you can select.

You can kick unwanted players out of not-yet-started game by clicking left on
You can kick unwanted players out of a game before it begins by clicking left on
them while holding the right mouse button.

When you are hosting a game it will automatically be listed on the lobby-server.
If you do not want your games to be listed on the lobby-server, you have to
When you are hosting a game it will automatically be listed on the lobby server.
If you do not want your games to be listed on the lobby-server, you should
change the entry "masterserver_name=lobby.wz2100.net" in your config to some-
thing invalid as "nomasterserverplease".
thing invalid, for example: "nomasterserverplease".

If you then want to see the games that are listed on the lobby-server you may
If you then want to see the games that are listed on the lobby server you may
enter "lobby.wz2100.net" when prompted to enter the host's IP or change the
entry in the config-file back. You will have to restart Warzone 2100 in order
for config-changes to take effect.
entry in the config file back. You will have to restart Warzone 2100 in order
for config changes to take effect.

Cheats
------

Like many other games Warzone 2100 features a certain set of cheats that can be
Like many other games, Warzone 2100 features a certain set of cheats that can be
used to have an advantage in the singleplayer-campaign and skirmish-games, or to
just help mod- and map-makers with testing. Cheats do not work in multiplayer,
just help mod-makers and map-makers with testing. Cheats do not work in multiplayer,
unless all players agree to it.

Cheats are likely to contain or trigger bugs, so use with care, especially
Expand All @@ -234,15 +234,15 @@ during campaign.
### Entering cheat mode

To be able cheats while in-game, press shift and backspace simultaneously.
An on-screen message should appear telling you that cheat-mode has been enabled.
An on-screen message should appear telling you that cheat mode has been enabled.
You can disable it using the same key combination again.

Pressing ctrl+o opens up the debug menu, which is useful for inspecting the
game state, or just messing around.

### Cheat commands

After activating cheat-mode cheats can be entered using the normal chat-
After activating cheat mode, cheats can be entered using the normal chat-
function. Cheats are ordered by their use and where they can be used.

There are many cheat commands. Some examples:
Expand All @@ -255,21 +255,21 @@ There are many cheat commands. Some examples:
* `let me win` - You win the current campaign mission
* `superpower` - Gives you maximum power
* `teach us` - Gives experience to selected units
* `makemehero` - Makes selected units Heros
* `clone wars` - Clone selected units (x10)
* `clone wars!` - Clone selected units (x40)
* `clone wars!!` - Clone selected units (x135)
* `makemehero` - Makes selected units Heroes
* `clone wars` - Clones selected units (x10)
* `clone wars!` - Clones selected units (x40)
* `clone wars!!` - Clones selected units (x135)
* `kill` - Kills selected object
* `john kettley` - Toggles weather conditions
* `get off my land` - Kills all enemy units and structures
* `showfps` - Show average FPS
* `showfps` - Shows average FPS
* `reload me` - Reloads selected weapon instantly
* `damage me` - Selected object takes 20% damage
* `showunits` - Displays unit count information
* `showorders` - Displays unit order/action state
* `droidinfo` - Show unit stats
* `droidinfo` - Shows unit stats

All available commands can be found in the file: https://github.com/Warzone2100/warzone2100/blob/master/src/cheat.cpp
All available commands can be found in this file: https://github.com/Warzone2100/warzone2100/blob/master/src/cheat.cpp

Modding information
-------------------
Expand Down Expand Up @@ -300,7 +300,7 @@ To properly build the game, either:
```
> Note: Initializing submodules is required.
Do **not** use GitHub's "Download Zip" option, as it does not contain submodules or the Git-based autorevision information.
Do **not** use GitHub's "Download Zip" option, as it **does not contain submodules** or the Git-based autorevision information.

### Linux

Expand Down
2 changes: 1 addition & 1 deletion data/base/sequenceaudio/cam1/sub17fmv.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

20 432 3.0 11.0 _("This Nexus Intruder Program is a self-mutating computer parasite. This makes it difficult to eradicate from systems once it has been identified.")

20 432 12.0 29.4 _("We have been unable to ascertain it's ultimate goal or function. In its initial form it seeks out and isolates sections of memory from the rest of the invaded system. It then begins to mutate itself and data structures, effectively reprogramming the system from within.")
20 432 12.0 29.4 _("We have been unable to ascertain its ultimate goal or function. In its initial form it seeks out and isolates sections of memory from the rest of the invaded system. It then begins to mutate itself and data structures, effectively reprogramming the system from within.")

20 432 30.0 38.4 _("Further analysis was prevented by the manual shutdown of the system by our technicians to prevent additional contamination by the Nexus Intruder Program.")

Expand Down
14 changes: 7 additions & 7 deletions doc/Behavior.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
This file describes what are primary and secondary states before/after a test.
It doesn't describe what one *wants* to happen, only facts.

If what you are currently experiencing in the game doesn't not correspond to
If what you are currently experiencing in the game does not correspond to
description in this file, then you should either update this file,
or to file a bug report.

Please do explicitely specify which version has been tested on: unintended changes
in behaviors between releases makes it impossible to leave the versionning implicit.
Please do explicitly specify which version has been tested on: unintended changes
in behaviors between releases makes it impossible to leave the versioning implicit.

Do explicitely specify what is secondary state before/after your test, don't rely on
Do explicitly specify what is secondary state before/after your test, don't rely on
your assumptions: de-select then re-select the unit once again, so that UI has no chance
of being stuck/stale.

Expand Down Expand Up @@ -83,7 +83,7 @@ When a VTOL is damaged, version 4.2.7:
When VTOL in FIRESUPPORT mode, attached to VTOL Strike Tower, version 4.2.7:
* VTOL DORDER_FIRESUPPORT LAG, gets damaged > threshold:
- does not get detached.
- when there is NO rearm pads, receives RTB order, even if repair stations
- when there are NO rearm pads, receives RTB order, even if repair stations
are available.
when reaches QG, lands on the ground with DORDER_NONE, DACTION_NONE
- when there are rearm pads, but VTOL is full ammo,
Expand Down Expand Up @@ -145,13 +145,13 @@ When "Return to repairs" is given to a commander (droid menu), version 4.2.7:


When a fighter unit is attached to commander, version 4.2.7:
* Commander GUARD, MRG or MRH, unit gets damaged > threshold:
* Commander GUARD, MRG or MRH, unit gets damaged beyond threshold:
- unit receives RTR, moves to a repair station
- when gets repaired, moves back to commander.
however, doesnt stop when reachees commander (DACTION_MOVE). Likely a bug.
Secondary order is synchronized to commander, primary is DORDER_GUARD

* attached unit gets damaged > threashold
* attached unit gets damaged beyond threshold:
- unit goes for repairs, but player orders the squad to move elsewhere
- unit cancels its movement toward repairs, and moves with the whole squad.
(This is likely a bug, we want damaged units to continue moving toward repairs,
Expand Down
2 changes: 1 addition & 1 deletion src/order.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1370,7 +1370,7 @@ void orderDroidBase(DROID *psDroid, DROID_ORDER_DATA *psOrder)
}
}

// if this is a command droid - all it's units do the same thing
// if this is a command droid - all its units do the same thing
if ((psDroid->droidType == DROID_COMMAND) &&
(psDroid->psGroup != nullptr) &&
(psDroid->psGroup->type == GT_COMMAND) &&
Expand Down
2 changes: 1 addition & 1 deletion win32/warzone2100.manifest.in
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<supportedOS Id="{4a2f28e3-53b9-4441-ba9c-d69d4a4a6e38}"/>
<!-- Windows 8.1 -->
<supportedOS Id="{1f676c76-80e1-4239-95bb-83d0f6d0da78}"/>
<!-- Windows 10 -->
<!-- Windows 10 and Windows 11 -->
<supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}"/>
</application>
</compatibility>
Expand Down

0 comments on commit 44cf33e

Please sign in to comment.