Skip to content

Commit 1c752fb

Browse files
author
Jared Lung
authored
Document newly introduced configuration options (#69)
* Documented the new configuration options that have been added. * Updated CommandMap.ini section to include SELECT_NEXT_IDLE_WORKER command. * Document CursorCaptureMode, forcefullviewport and ViewportHeightScale
1 parent 1ac070c commit 1c752fb

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

SourceCode/_Sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [How to Get Involved](how_to_involved)
66
- [How to Contribution](https://github.com/TheSuperHackers/GeneralsGameCode/blob/main/CONTRIBUTING.md)
77
- [Replays for testing](replay_testing)
8+
- [New Configuration Options](new_configuration_options)
89
- [In-Game Debug Commands](ingame_debug_commands)
910
- [Community forks](forks)
1011
- [License](https://github.com/TheSuperHackers/GeneralsGameCode/blob/main/LICENSE.md)
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!-- markdownlint-disable MD033 -->
2+
<!-- Needed to allow for <kbd> tags for keyboard key styling. -->
3+
# New Configuration Options
4+
5+
Several new configuration options have been added to the game. The new configuration options can be
6+
configured from the following locations:
7+
8+
## Options.ini
9+
10+
| Name | Description | Accepted Values | Default Value |
11+
|-----------------|---------------------------------------------------------------------------------------------|-----------------|----------------|
12+
| MoneyTransactionVolume | Controls the volume of money deposit and withdraw audio events. Set to 0 to mute these sounds. | 0-100 | 100 (Generals), 0 (Zero Hour) |
13+
| SystemTimeFontSize | Controls the font size for system time display. Set to 0 to disable the system time display. | 0+ | 8 |
14+
| GameTimeFontSize | Controls the font size for game time display. Set to 0 to disable the game time display. | 0+ | 8 |
15+
| CursorCaptureMode | Controls when the game window captures the mouse cursor. | None, InGame, Always, Auto | Auto |
16+
17+
## CommandMap.ini
18+
19+
| Name | Description | Default Keybinding |
20+
|-------------------------|------------------------------------------|-------------------|
21+
| TOGGLE_PAUSE | Toggles pause in replay playback | <kbd>P</kbd> |
22+
| STEP_FRAME | Steps one frame in replay playback | <kbd>O</kbd> |
23+
| SELECT_NEXT_IDLE_WORKER | Selects the next idle worker unit | <kbd>Ctrl</kbd>+<kbd>I</kbd> |
24+
25+
## GameData.ini
26+
27+
| Name | Description | Accepted Values | Default Value |
28+
|------|-------------|-----------------|---------------|
29+
| ViewportHeightScale | Controls the height scale of the tactical view. Used to hide the world behind the Control Bar for 'Control Bar Pro' Addons. | 0.0 - 1.0 | 0.8 |
30+
31+
## Command Line Arguments
32+
33+
| Argument | Description |
34+
|----------|-------------|
35+
| -forcefullviewport | Forces full viewport mode for 'Control Bar Pro' Addons by setting ViewportHeightScale to 1.0 |
36+
37+
## CursorCaptureMode Details
38+
39+
The `CursorCaptureMode` option controls when the game window captures the mouse cursor, preventing it from
40+
leaving the game window boundaries. This is particularly useful for windowed mode gameplay.
41+
42+
| Mode | Behavior |
43+
|------|----------|
44+
| **None** | Game window does not capture the cursor |
45+
| **InGame** | Game window captures the cursor when playing and observing |
46+
| **Always** | Game window captures the cursor always in menus and game |
47+
| **Auto** | Applies mode "InGame" when Windowed, "Always" when Fullscreen |
48+
49+
The cursor capture is automatically released when the game window loses focus (e.g., when Alt+Tab is used to
50+
switch to another application).
51+
52+
## ViewportHeightScale Details
53+
54+
The `ViewportHeightScale` setting controls the height of the tactical view as a fraction of the screen height.
55+
This feature is specifically designed to support 'Control Bar Pro' Addons that modify the game's interface.
56+
57+
**Values:**
58+
59+
- `0.8` (default): Traditional control bar mode, tactical view uses 80% of screen height
60+
- `1.0`: Full viewport mode, tactical view uses entire screen height (control bar overlays the view)
61+
- Custom values between `0.0` and `1.0` for custom control bar configurations
62+
63+
**Integration with Control Bar Pro Addons:**
64+
The game reads a `GenTool/fullviewport.dat` file to automatically enable full viewport mode when detected.

0 commit comments

Comments
 (0)