-
Notifications
You must be signed in to change notification settings - Fork 24
Document newly introduced configuration options #69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c719be4
Documented the new configuration options that have been added.
f5da560
Merge branch 'TheSuperHackers:main' into jaredl/document-new-configur…
11e7b7f
Updated CommandMap.ini section to include SELECT_NEXT_IDLE_WORKER com…
c9daf68
Document CursorCaptureMode, forcefullviewport and ViewportHeightScale
de70571
Merge branch 'TheSuperHackers:main' into jaredl/document-new-configur…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| <!-- markdownlint-disable MD033 --> | ||
| <!-- Needed to allow for <kbd> tags for keyboard key styling. --> | ||
| # New Configuration Options | ||
|
|
||
| Several new configuration options have been added to the game. The new configuration options can be | ||
| configured from the following locations: | ||
|
|
||
| ## Options.ini | ||
|
|
||
| | Name | Description | Accepted Values | Default Value | | ||
| |-----------------|---------------------------------------------------------------------------------------------|-----------------|----------------| | ||
| | 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) | | ||
| | SystemTimeFontSize | Controls the font size for system time display. Set to 0 to disable the system time display. | 0+ | 8 | | ||
| | GameTimeFontSize | Controls the font size for game time display. Set to 0 to disable the game time display. | 0+ | 8 | | ||
| | CursorCaptureMode | Controls when the game window captures the mouse cursor. | None, InGame, Always, Auto | Auto | | ||
|
|
||
| ## CommandMap.ini | ||
|
|
||
| | Name | Description | Default Keybinding | | ||
| |-------------------------|------------------------------------------|-------------------| | ||
| | TOGGLE_PAUSE | Toggles pause in replay playback | <kbd>P</kbd> | | ||
| | STEP_FRAME | Steps one frame in replay playback | <kbd>O</kbd> | | ||
| | SELECT_NEXT_IDLE_WORKER | Selects the next idle worker unit | <kbd>Ctrl</kbd>+<kbd>I</kbd> | | ||
|
|
||
| ## GameData.ini | ||
|
|
||
| | Name | Description | Accepted Values | Default Value | | ||
| |------|-------------|-----------------|---------------| | ||
| | 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 | | ||
|
|
||
| ## Command Line Arguments | ||
|
|
||
| | Argument | Description | | ||
| |----------|-------------| | ||
| | -forcefullviewport | Forces full viewport mode for 'Control Bar Pro' Addons by setting ViewportHeightScale to 1.0 | | ||
|
|
||
| ## CursorCaptureMode Details | ||
|
|
||
| The `CursorCaptureMode` option controls when the game window captures the mouse cursor, preventing it from | ||
| leaving the game window boundaries. This is particularly useful for windowed mode gameplay. | ||
|
|
||
| | Mode | Behavior | | ||
| |------|----------| | ||
| | **None** | Game window does not capture the cursor | | ||
| | **InGame** | Game window captures the cursor when playing and observing | | ||
| | **Always** | Game window captures the cursor always in menus and game | | ||
| | **Auto** | Applies mode "InGame" when Windowed, "Always" when Fullscreen | | ||
|
|
||
| The cursor capture is automatically released when the game window loses focus (e.g., when Alt+Tab is used to | ||
| switch to another application). | ||
|
|
||
| ## ViewportHeightScale Details | ||
|
|
||
| The `ViewportHeightScale` setting controls the height of the tactical view as a fraction of the screen height. | ||
| This feature is specifically designed to support 'Control Bar Pro' Addons that modify the game's interface. | ||
|
|
||
| **Values:** | ||
|
|
||
| - `0.8` (default): Traditional control bar mode, tactical view uses 80% of screen height | ||
| - `1.0`: Full viewport mode, tactical view uses entire screen height (control bar overlays the view) | ||
| - Custom values between `0.0` and `1.0` for custom control bar configurations | ||
|
|
||
| **Integration with Control Bar Pro Addons:** | ||
| The game reads a `GenTool/fullviewport.dat` file to automatically enable full viewport mode when detected. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is in this document temporarily until #65 is completed.