Skip to content

Commit 86f5fac

Browse files
netniVnetniV
committed
Add a features list
1 parent 51b3821 commit 86f5fac

2 files changed

Lines changed: 181 additions & 0 deletions

File tree

‎FEATURES.md‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# STFC Community Mod Features
2+
3+
The STFC Community Mod adds configurable quality-of-life improvements to the desktop version of Star Trek Fleet Command. This catalog describes the user-facing features represented by the current source code and English example configuration.
4+
5+
Most options are configured in `community_patch_settings.toml`. The mod creates a default settings file when one is missing and also writes a parsed settings file so you can see the values that were applied. Nearly every shortcut can be remapped; see [`KEYMAPPING.md`](KEYMAPPING.md) for valid key names.
6+
7+
## Display and window controls
8+
9+
- Set the overall interface scale and the amount changed by each scale adjustment.
10+
- Scale object viewers independently from the main interface.
11+
- Scale ship models in System View independently from the interface.
12+
- Adjust the interface, viewer, and ship scales while playing with configurable shortcuts.
13+
- Enable freely resizable game windows on Windows.
14+
- Enable borderless fullscreen mode and switch between fullscreen and windowed mode without restarting the game.
15+
- Control whether the game replaces the system cursor.
16+
- Adjust the frame-rate scaling factor used by visual effects.
17+
- Set the duration of screen transitions.
18+
19+
## System View camera and navigation
20+
21+
- Increase the maximum System View zoom distance.
22+
- Set the zoom level used when entering a system.
23+
- Configure five System View zoom presets.
24+
- Zoom in, zoom out, jump to minimum or maximum zoom, and reset zoom by shortcut.
25+
- Save the current zoom or a preset as the new default.
26+
- Configure keyboard zoom speed.
27+
- Configure System View pan momentum and momentum falloff.
28+
- Use keyboard movement controls for System View, or disable those movement keys.
29+
- Configure player and non-player fleet labels to use native, expanded, compact, or zoom-threshold-based detail.
30+
- Configure separate fleet-label zoom thresholds for player and non-player fleets.
31+
32+
## Hotkeys and screen navigation
33+
34+
- Enable or disable all hotkeys.
35+
- Choose between the community mod hotkeys and Scopely's native hotkeys.
36+
- Enable an extended set of mod shortcuts.
37+
- Remap shortcuts in the settings file, including multiple keys or mouse buttons for one action.
38+
- Open or focus commonly used screens directly, including:
39+
- Alliance, Alliance Armada, and Alliance Help.
40+
- Artifact Gallery, Away Teams, Battle Reports, Bookmarks, and Chat.
41+
- Command Center, Daily Missions, Events, ExoComp, Factions, and Fleet Commander.
42+
- Galaxy View, System View, Station Exterior, and Station Interior.
43+
- Gifts, Haven, Inventory, Missions, Officers, Q Trials, Refinery, Research, and Scrap Yard.
44+
- Settings, shield selection, ship construction, ship management, and ship swapping.
45+
- Open Alliance, Galaxy, and Private chat tabs directly.
46+
- Focus the current screen's search field with a shortcut.
47+
- Use configurable primary-action, alternate-action, queue, recall, repair, and cancel shortcuts.
48+
- Select ships 1 through 8 and configure the double-tap timing used to locate a selected ship.
49+
- Recall a selected ship or perform context-sensitive actions against mines, players, hostiles, and other targets.
50+
- Clear focused text or close chat with Escape.
51+
52+
## Combat and ship interaction
53+
54+
- Enable the Kir'Shara attack queue by default when the artifact is owned.
55+
- Add targets to the Kir'Shara queue, clear the queue, or toggle queuing by shortcut.
56+
- Use a configurable primary action for context-sensitive attacks, warps, and cancellations.
57+
- Choose the automatic action for the instant-warp confirmation: show the dialog, use regular warp, or use instant jump.
58+
- Configure ship-name lists that always use regular warp, always use instant jump, or always show the confirmation dialog.
59+
- Cycle the current instant-warp behavior by shortcut.
60+
- Keep the warp action label consistent with the selected automatic action.
61+
- Automatically confirm Forbidden Tech level and tier upgrades when enabled.
62+
63+
## Cargo and target previews
64+
65+
- Show cargo or rewards automatically in the default target preview.
66+
- Configure cargo visibility independently for player ships, stations, hostiles, and armadas.
67+
- Toggle each cargo-preview mode while playing.
68+
- Switch between cargo and the normal target view with a shortcut.
69+
- Close pre-scan and target viewers with Escape.
70+
- Allow or block locate and recall actions while previews are open, with runtime toggles for both behaviors.
71+
- Show cargo totals immediately instead of playing the native count-up animation on supported Windows clients.
72+
- Configure the number of decimal places used for abbreviated cargo values such as `1.25M`.
73+
74+
## Fleet and officer management
75+
76+
- Select the previous or next ship in the fleet-management dock with the Left and Right arrow keys.
77+
- Double-click a ship in the fleet-management dock to assign it.
78+
- Pin configured ship names to the front of the fleet-management dock while preserving the selected sort order.
79+
- Restore the **Below Deck Ability** sorting option to officer roster and assignment screens.
80+
- Show a ship's out-of-dock power while it is docked.
81+
82+
## Rewards donations and Daily Goals
83+
84+
- Skip chest-reveal animations and open rewards immediately.
85+
- Extend the Alliance donation slider to a configurable maximum.
86+
- Extend supported tagged chest-purchase sliders to a configurable maximum on Windows.
87+
- Open the bulk gift-claim flyout automatically when entering Gifts.
88+
- Exit the relevant section after gift collection through the mod's streamlined gift flow.
89+
- Apply the Daily Goals **Claim All** behavior only to selected Federation, Klingon, or Romulan goals.
90+
- Force the Daily Goals **Claim All** toggle on the first time the screen is opened in a session.
91+
92+
## Chat interface and HUD
93+
94+
- Hide Galaxy Chat.
95+
- Hide Veil Chat.
96+
- Open Chat full-screen or docked on either side by shortcut.
97+
- Control the visibility of the Daily Goals, Field Training, Missions, Outposts, and Q Trials HUD buttons.
98+
- Set each supported HUD item to native automatic behavior, always shown, or always hidden.
99+
- Prevent Escape from opening the game-exit prompt.
100+
- Optionally require a configurable double press of Escape before showing the exit prompt.
101+
102+
## Banners audio and popups
103+
104+
- Suppress selected toast-banner types.
105+
- Send desktop notifications for selected banner types.
106+
- Disable standard toast banners through the experimental global toggle.
107+
- Suppress selected audio events by event name.
108+
- Trace audio event names to the log to help build a suppression list.
109+
- Automatically confirm Discovery prompts.
110+
111+
## Loading and transition screens
112+
113+
- Replace the login loading background with the mod's embedded artwork.
114+
- Load a custom loading-screen image from a configured path.
115+
- Scale the loading-screen logo.
116+
- Show rotating community-mod tips on the loading screen.
117+
- Reuse the loading artwork during transitions.
118+
- Use a black transition background instead of artwork.
119+
120+
## Data synchronization
121+
122+
- Sync selected game data to one or more configured community services.
123+
- Configure independent sync targets, including custom endpoints and access tokens.
124+
- Sync any combination of:
125+
- Battle logs.
126+
- Buffs.
127+
- Buildings.
128+
- Inventory and resources.
129+
- Jobs and missions.
130+
- Owned officers, ships, and Forbidden Tech.
131+
- Research.
132+
- Slots.
133+
- Traits.
134+
- Use the built-in target definitions for STFC Data, Spock's Club, and Next Spock's Club.
135+
- Route sync traffic through a proxy.
136+
- Enable or disable SSL certificate verification.
137+
- Configure resolver caching, diagnostic logging, and detailed debug logging.
138+
139+
## Reliability and configuration support
140+
141+
- Apply client-specific crash fixes and compatibility patches.
142+
- Generate a default TOML settings file if no configuration exists.
143+
- Generate a parsed TOML file showing the settings actually applied at runtime.
144+
- Enable or disable patch groups independently in development builds.
145+
- Log mod initialization, patch installation, and optional sync or audio diagnostics for troubleshooting.
146+
- Support both Windows and macOS through platform-specific injection and loading components.
147+
148+
## Platform and availability notes
149+
150+
- Windows and macOS do not necessarily expose every feature in exactly the same way.
151+
- Free window resizing and extended tagged chest-purchase sliders are Windows-specific.
152+
- The instant cargo counter is guarded for a supported Windows client build; unsupported builds retain the native animation.
153+
- Some settings are experimental or diagnostic and may be disabled, client-version-specific, or intended for troubleshooting.
154+
- Patch availability can change when the game client changes because the mod hooks the native IL2CPP runtime.
155+
156+
## Default shortcut overview
157+
158+
The default shortcut map includes the following high-use controls. All of these can be changed in the settings file.
159+
160+
| Action | Default shortcut |
161+
| --- | --- |
162+
| Zoom presets | `F1` to `F5` |
163+
| Zoom in or out | `Q` or `E` |
164+
| Minimum maximum or default zoom | `BACKSPACE` `MINUS` or `=` |
165+
| Main interface scale | `PGUP` or `PGDOWN` |
166+
| Viewer scale | `SHIFT-PGUP` or `SHIFT-PGDOWN` |
167+
| Ship model scale | `CTRL-PGUP` or `CTRL-PGDOWN` |
168+
| Open full-screen chat | `C` |
169+
| Open side chat | `ALT-C` or `` ` `` |
170+
| Select or focus ships | `1` to `8` |
171+
| Primary action or queue action | `SPACE` or `MOUSE1` |
172+
| Recall or alternate action | `R` |
173+
| Toggle cargo view | `V` |
174+
| Toggle Kir'Shara queue | `CTRL-Q` |
175+
| Clear Kir'Shara queue | `CTRL-C` |
176+
| Focus search | `CTRL-F` |
177+
| Toggle borderless fullscreen | `F11` |
178+
179+
For the complete shortcut list and the names accepted by the configuration parser, see [`README.md`](README.md) and [`KEYMAPPING.md`](KEYMAPPING.md).

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ This project is maintained solely at my own cost of time, energy and money. Any
5151
- Create parsed toml file to show what settings have been applied
5252
- Customise your keyboard shortcuts
5353

54+
For a full list of features see our [FEATURES.md](FEATURES.md)
55+
5456
## Installing
5557

5658
Please see the [INSTALL.md](INSTALL.md) instructions which has steps on how to use this mod with Star Trek Fleet Command.

0 commit comments

Comments
 (0)