tashcan / bob

GNU General Public License v3.0
60 stars 14 forks source link

Star Trek Fleet Command - Community Patch

License: GPLv3

A community patch that adds a couple of tweaks to the mobile game Star Trek Fleet Command™

Features

Keyboard shortcuts

The following are default shortcuts that can be modified (see KEYMAPPING.md)

Key Shortcut
SPACE Perform default action
1-8 Ship select/focus
F1-F5 Zoom presets
Q Zoom Out
E Zoom In
T Events
G Galaxy
H System
Shift-G Exterior View
Shfit-H Interior View
R When ship selected, recall ship
R When clicking on mine/player/enemy, perform non-default action (eg, scan)
V When clicking on mine/player/enemy, toggle view of cargo or default screen
C Focus Chat (or Open Alliance Chat - Full Screen)
Alt-C Focus Chat (or Open Alliance Chat - Side of Screen)
PGUP UI Scale Up
PGDOWN UI Scale Down

The following keybinds have recently been added:

[!NOTE] Can be disabled via hotkeys_extended config option

Key Shortcut
MINUS Zoom (min)
EQUAL Zoom (default)
BACKSPACE Zoom (max)
B Bookmarks
F Factions
Shift-F reFinery
I Inventory
M Active Missions
O Command Center
Shift-O Officers
Shift-Q Q-Trials
Shift-T Away Teams
X ExoComp
Z Daily Missions
` Open Alliance Chat - Side of Screen

Contributing / Building

If you wish to contribute to the project, or simply compile the DLL yourself, please see CONTRIBUTING.md

Installation / Runtime

Both the DLL and the toml file must be placed in the STFC game folder which is always located at C:\Games\Star Trek Fleet Command\Star Trek Fleet Command\default\game as the following names:

The pre-compiled DLL can be downloaded from the official assets hosted on GitHub Releases

Configuration

An example configuration file is example_community_patch_settings.toml and should be renamed to community_patch_settings.toml. When running this file will be parsed (see community_patch.log) and the running values can be found in community_patch_runtime.vars. If you have any problems with a setting, check the log and parsed file to verify that the setting was applied.

Problems?

The most common problems getting the DLL to work are:

  1. Not installed in the correct location. This must be:

    C:\Games\Star Trek Fleet Command\Star Trek Fleet Command\default\game
  2. Windows is blocking the DLL. Right-click the file and select Properties. On the General tab there will be additional text at the bottom:

    This file can from another
    computer and might be blocked to
    help protect this computer

    To the right of this, there will be a tick box called Unblock. Tick the box and then click OK to unblock the file.

  3. The configuration file has the wrong name (see above)

  4. The configuration file is not being parsed as you expect which is normally because:

    • Your configuration isn't being parsed
    • The configuration option name is spelt wrong
    • The configuration option name is in the wrong section
    • The configuration option value is not a true or false

    You can verify your configuration by looking at community_patch_runtime.vars and/or the log file community_patch.log.

Support

Tashcan has now retired all things STFC from Ripper's Corner but still swing by to say hello to the wonderful man.

For STFC Community Mod items, please visit the STFC Community Mod discord server.

Disclaimer

This is intended to give people insight and possiblity to add new things for QoL improvements.

There is no guarantee or promise that using this for features outside of what is officially offered via this repository will not result actions against your account.

All features and additions provided here via this repository are sanctioned by Scopely and thus aren't subject to account actions.

License