HomeWildfire Games

manual/intro.txt corrections

Description

manual/intro.txt corrections

Summary:
Another follow-up to D1719 and D1744. This one does the following:

  • [font="sans-14"] (default) at the end of the line that used a different font, rather than at the beginning of the next line (no net change, but looks better in the file)
  • two spaces for indentation of hotkeys (looks better in game)
  • (space en-dash space) instead of : (colon space) to separate hotkey and description, for better visibility and consistency.
  • 6400px by 4800px6400×4800 pixels
  • removed Alt+W entry (superseded by Alt+Shift+W above)
  • inserted Esc entry under save game for completeness
  • rephrased several descriptions

Before:


After:

Test Plan: Launch the game and open the manual.

Reviewers: O7 Catchall, Gallaecio, elexis, Itms

Reviewed By: Gallaecio

Subscribers: Freagarach, O8 JS GUI, Stan, elexis

Differential Revision: https://code.wildfiregames.com/D2110

Details

Event Timeline

elexis added a subscriber: elexis.Sep 16 2019, 2:41 PM

Usually default.cfg and intro.txt are kept in sync with the same text

Nescio added a subscriber: Nescio.Sep 17 2019, 10:02 AM

Where and what is default.cfg?

Stan added a subscriber: Stan.Sep 17 2019, 10:06 AM

default.cfg is as its name suggest the default configuration for the game. When not overriden by user.cfg, all config values are read from there.
You can find it here:

ps/trunk/binaries/data/config/default.cfg

Thanks, that explains why I couldn't find it in the public folder!

Here an example of how a default.cfg / intro.txt change is properly applied rP21173, rP22650.
Here an example where they are mostly similar but differ rP21339 that I wanted to fix in D2273.

For example this patch correctly changed

Alt + C: Toggle attack range visualizations of selected defensive structures

to

Alt + C – Toggle attack range visualizations of selected units and structures

But in default.cfg we still have:

session.toggleattackrange = "Alt+C" ; Toggle display of attack range overlays of selected defensive structures

In fact, when changing hotkeys, there have to be three places kept in sync, the third one is this:
https://trac.wildfiregames.com/wiki/HotKeys

The more the files go out of sync, the harder it will be to keep them in sync.
If the files contain actually differing descriptions what the hotkey does (for example one says that the hotkey opens the page, and the other says it opens or closes the page) then it will become even hard or impossible to figure out what the hotkey was actually meant to do.
(I suppose if the changes in this diff are worthwhile for reasons, they are also worthwhile in the other places for the same reasons)