Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
name: Bug report
about: Report a problem with the mod, installation, or settings.
title: ''
labels: ''
assignees: ''
---

## Checks before reporting

<!-- Tick the checks you completed. Leave checks that do not apply unchecked. -->

- [ ] I checked existing issues for the same problem.
- [ ] I read the [installation and troubleshooting guide](https://github.com/STFC-Mod/mod/blob/dev/docs/INSTALL.md#fix-installation-problems).
- [ ] I checked the latest release and Discord **#info** for a hotfix, especially after a game update.
- [ ] I checked `community_patch.log` for startup, settings, or hook errors.
- [ ] For settings problems, I checked the section, spelling, and value type against the example and compared `community_patch_runtime.vars`.
- [ ] After changing a `[patches]` setting, I fully restarted the game.

## Platform checks

<!-- Tick the checks relevant to your platform. -->

- [ ] Windows: `version.dll` is beside the running game's `prime.exe`, not in the official launcher's folder; I checked **Properties > General > Unblock** on the DLL.
- [ ] macOS: I started the game through **STFC Community Mod** and accepted any entitlement repair prompt.
- [ ] Wine: the `version` DLL override is set to **native, then builtin** (`n,b`).

## Platform and versions

- Platform: <!-- Windows / macOS / Wine -->
- Operating system and version: <!-- Include the host OS if using Wine. -->
- Processor architecture: <!-- Apple Silicon / Intel / AMD -->
- Game version/build:
- Mod version: <!-- Include the commit hash for a development build. -->
- Mod download/build source: <!-- Release link, beta, or local build. -->
- Community Mod launcher version, if using macOS:
- Wine/CrossOver/Proton version and runner, if applicable:

## What happened

<!-- Describe the problem and what you expected to happen instead. -->

## Steps to reproduce

1.
2.
3.

<!-- Does it happen every time? Did it start after a game or mod update? -->

## Logs and settings

<!-- Attach community_patch.log from an affected session, or paste the relevant lines below.
Include relevant settings and runtime values; do not edit community_patch_runtime.vars to change settings.

IMPORTANT: Remove sync tokens, passwords, and other private information before posting.

For crashes, please try to have a crash report if available, it should be sent by discord upon request. Screenshots or video can also help and should be provided here. -->

```text
Paste relevant log lines here.
```

```toml
# Paste relevant settings here.
```
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Target dev for development pull requests. Remove sections that do not apply. -->

## What changed and why

<!-- Describe the problem and the resulting behavior. Link any related issue. -->

## Validation

<!-- List checks performed and their results, including in-game checks when relevant. -->

## Settings and platforms

<!-- Note new or changed settings, defaults, restart requirements, or platform limitations. -->
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.vscode/*
!.vscode/extensions.json
!.vscode/settings.json
!.vscode/tasks.json
.vs/
/.idea/
/out/
Expand Down
19 changes: 17 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,20 @@
"clangd.arguments": [
"--compile-commands-dir=.vscode"
],
"cmake.ignoreCMakeListsMissing": true
}
"cmake.ignoreCMakeListsMissing": true,
"[c]": {
"editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd",
"editor.formatOnSave": true
},
"[cpp]": {
"editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd",
"editor.formatOnSave": true
},
"[zig]": {
"editor.defaultFormatter": "ziglang.vscode-zig",
"editor.formatOnSave": true
},
"[objective-cpp]": {
"editor.formatOnSave": false
}
}
18 changes: 18 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Format project",
"type": "process",
"command": "zig",
"args": [
"build",
"fmt"
],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
}
]
}
4 changes: 4 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Agent guide

<p align="center">
<img src="https://repository-images.githubusercontent.com/693298224/6a87716f-3dbb-48a5-80e0-709e0a1ad133" alt="STFC Community Mod">
</p>

STFC Community Mod hooks a Unity IL2CPP game to add desktop features on Windows and macOS.
Read [CONTRIBUTING.md](CONTRIBUTING.md) for builds and tests.
Before changing bindings or hooks, read the [IL2CPP reference](docs/IL2CPP.md).
Expand Down
129 changes: 128 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,135 @@
# Changelog
# Changelog for STFC Community Mod

<p align="center">
<img src="https://repository-images.githubusercontent.com/693298224/6a87716f-3dbb-48a5-80e0-709e0a1ad133" alt="STFC Community Mod">
</p>

These are historical release notes. Settings, shortcuts, and build tools below describe those releases.
For current behavior, see [Features](docs/FEATURES.md), [Keyboard shortcuts](docs/KEYMAPPING.md), and [Contributing](CONTRIBUTING.md).

## Unreleased

Changes on `dev` since the `v1.1.10.0` tag. Pending working-tree changes are not included.

### Features and fixes

- Added dock switching in the ship management screen.
- Added opt-in live fleet-state sync through `fleets` and enabled Kir'Shara queue protections on macOS.
- Fixed wave joining and chat auto-opening, Alliance Games Store research and purchase refresh,
galaxy-map drag momentum, and station-exterior zoom restoration after visiting the interior.
- Fixed fleet-sync number conversion on supported macOS versions and the first-sync flag for Haven.
- Improved Galactic Anomaly timer recovery across HUD canvases.
- Fixed initial system zoom and added guards during restart and macOS runtime shutdown.
- Made sync delivery track acknowledgements independently for each target, retry failed uploads,
and reject work from previous login sessions. Sync workers retain settings safely across reloads.
- Improved pooled inventory-widget tracking, mission HUD refreshes, ship pinning, shortcut sequencing,
and notification text substitution. Store-popup suppression now keeps the first popup per session.

### Development

- Replaced XMake with Zig builds and packaging, supporting Zig 0.16 and 0.17.
- Added typed IL2CPP bindings, shared Unity helpers, and transactional feature hook installation.
- Updated SPUD, reorganized sources under `src`, and expanded native tests.
- Hardened the macOS loader and launcher and rewrote installation and contributor guides.
- Restricted release tags to their appropriate branches.

## 1.1.10

Includes changes from the 1.1.9 beta series.

### Features

- Added cross-platform notification audio cues and an `All` wildcard for named audio suppression.
- Added an opt-in Galactic Anomaly countdown, configurable instant cargo totals, and automatic
Warp/Jump labels on the system course button.
- Added station-interior zoom-out, expanded Haven zoom with road-surface detail, and applied backdrop
scaling on system entry. Added an option to disable target camera lock.
- Added Shift+click ship pinning, preferred ships with applied Forbidden Tech when pinned levels tie,
and expanded ship-management, ship-swap, officer-swap, and officer-preset shortcuts.
- Added options to hide chat player titles and the artifact Exchange All button.
- Added confirmation skipping for the Excelsior's Decloaking Deflector and the Alliance max-level
contribution warning, plus Forbidden Tech names in selection lists.
- Added sync for Away Team assignments and trait demand, Haven building pieces and map data,
and opt-in local-player profiles and faction-store offers.
- Added log history and newest-first Haven help history.

### Fixes

- Protected and recovered Kir'Shara queues after target or address changes.
- Restored battle-log and ship sync for client build 267 and re-emitted job events when timing changes.
- Fixed artifact-gallery navigation, mission HUD visibility, player titles on Windows, and ship shortcut
hints when dock indices have gaps.
- Preserved 64-bit ship locale IDs and fixed x64 trampoline offsets when multiple instructions expand.
- Made empty shortcut strings disable bindings, coordinated WASD movement with configured hotkeys,
and corrected feature and patch enablement.
- Made daily faction bulk-claim defaults explicit and primary-action target visibility protection opt-in.

## 1.1.8

Includes changes from the 1.1.7 beta series.

### Features

- Added faction filtering for daily bulk claims, configurable fleet-label detail, and native navigation actions.
- Added construction, battle-log, and shield shortcuts, and displayed mod bindings in native shortcut hints.
- Improved ship management and added arrow-key rotation of the station exterior.
- Added named audio suppression, per-ship instant-jump configuration, and tagged-chest purchase sliders.
- Restored configurable double-tap Escape exit and added a clear-cache-and-restart shortcut.
- Added macOS `-ccm` settings-path overrides, Haven support, and Windows DLL build provenance and attestation.

### Fixes

- Fixed text-input focus detection, modified directional hotkeys, and armada notifications.
- Fixed bulk-claim flyouts reopening after reward presentation and limited daily faction filtering to
Federation, Klingon, and Romulan dailies.
- Extended donation sliders on macOS, corrected base-raid defender names in battle logs, and fixed
the garbage-collector finalizer callback.

## 1.1.6

Includes changes from the 1.1.5 beta series.

### Features

- Added mission HUD visibility settings, cargo-format precision, BDA officer sorting, and ship-level scaling.
- Added automatic confirmation for Forbidden Tech upgrades and instant warp.
- Added left/right arrow navigation for artifacts and translated example settings.

### Fixes

- Restored sync compatibility with M93.3.0 and corrected RTC slot parsing and Alliance resource sync names.
- Fixed macOS ARM64 loading-transition crashes, stale zoom scene pointers, and Right Alt detection.
- Restored unlimited donation sliders and stopped converting empty legacy sync targets.
- Removed the obsolete resolution-list patch and improved local universal macOS packaging.

## 1.1.4

### Features

- Added Ctrl+F coordinate search and automatic opening of the Gifts bulk-claim flyout.
- Added a build option to preserve the game's original loading background.

### Fixes

- Restored slot sync and updated bindings for client 1.000.50296.
- Hardened shortcut parsing and allowed recall and repair while a viewer popup is open, preserving scan priority.
- Honored patch switches in release builds and made the GameServer initialization sync hook optional.
- Fixed macOS zoom-range limits and loading-screen assets across scene transitions.

## 1.1.2

### Features

- Added zoom scaling and camera controls, custom embedded loading artwork, and loading-logo fade-in.
- Added the notification foundation and battle text, plus `ALL` logging selection.
- Added compressed update artifacts for the macOS launcher and improved updater diagnostics and packaging.

### Fixes

- Fixed sync parser crashes and the changed macOS BuffService parser signature.
- Fixed chained Xsolla patch updates and loading-texture resets.
- Removed the remaining system-view border and required the same fleet key for double-tap locate.

## 1.1.0

### Features
Expand Down
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ git diff --check
`fmt` requires `clang-format` on `PATH`.
It formats C++ under `src` and `tests`, plus the Zig build files. It skips Objective-C++ `.mm` files.

In VS Code, install the workspace-recommended Zig and clangd extensions. Workspace settings enable
formatting on save for C++ and Zig, using `.clang-format` and `zig fmt` respectively.
Use **Tasks: Run Task → Format project** to run `zig build fmt` across the project.
The task requires `zig` and `clang-format` on `PATH`; Objective-C++ format on save is disabled.

Choose the relevant native tests:

| Command | Coverage |
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,30 @@ It adds adjustable UI scaling, camera controls, keyboard shortcuts, cargo previe
| Find or change a shortcut | [Keyboard shortcuts](docs/KEYMAPPING.md) |
| See what the mod can do | [Features](docs/FEATURES.md) |
| Build or contribute code | [Contributing](CONTRIBUTING.md) |
| Example configuration files | [Example settings](docs/EXAMPLE_SETTINGS.md) |

Download the [latest release](https://github.com/STFC-Mod/mod/releases/latest/).

For test builds, use the [release list](https://github.com/STFC-Mod/mod/releases/).

If a game update breaks the mod, check **#info** in the
[STFC Community Mod Discord](https://discord.gg/PrpHgs7Vjs) for hotfixes.

## Get help

Use the [Discord server](https://discord.gg/PrpHgs7Vjs) for support.
Include your operating system, game version, mod version, and the relevant lines from `community_patch.log`.
The [installation guide](docs/INSTALL.md#fix-installation-problems) covers common problems.
- Use the [Discord server](https://discord.gg/PrpHgs7Vjs) for support.

- Include your operating system, game version, mod version, and the relevant lines from `community_patch.log`.

- The [installation guide](docs/INSTALL.md#fix-installation-problems) covers common problems.

## Project details

The project accepts [code contributions](CONTRIBUTING.md) and
[sponsorship](https://github.com/sponsors/netniV).

See the [changelog](CHANGELOG.md) for recorded releases.

The mod uses the [GPLv3 license](LICENSE).
[Third-party notices](docs/THIRD_PARTY.md) and
The mod uses the [GPLv3 license](LICENSE). [Third-party notices](docs/THIRD_PARTY.md) and
[Windows DLL verification](docs/WINDOWS_DLL_PROVENANCE.md) have their own references.
There is no account-safety guarantee for features added outside this repository.
22 changes: 22 additions & 0 deletions docs/EXAMPLE_SETTINGS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Example settings

<p align="center">
<img src="https://repository-images.githubusercontent.com/693298224/6a87716f-3dbb-48a5-80e0-709e0a1ad133" alt="STFC Community Mod">
</p>

Choose an example in your preferred language and save a copy as `community_patch_settings.toml`
in your [settings folder](INSTALL.md#change-settings). Back up an existing settings file before replacing it.

The English example tracks the current code. Translations may lag behind; setting names remain the same in every language.

| Language | Example settings |
| --- | --- |
| 🇬🇧 English | [English example](configuration/example_community_patch_settings_en.toml) |
| 🇩🇪 Deutsch | [Deutsches Beispiel](configuration/example_community_patch_settings_de.toml) |
| 🇳🇱 Nederlands | [Nederlands voorbeeld](configuration/example_community_patch_settings_nl.toml) |
| 🇫🇷 Français | [Exemple français](configuration/example_community_patch_settings_fr.toml) |
| 🇪🇸 Español | [Ejemplo en español](configuration/example_community_patch_settings_es.toml) |
| 🇷🇺 Русский | [Пример на русском](configuration/example_community_patch_settings_ru.toml) |
| 🇩🇰 Dansk | [Dansk eksempel](configuration/example_community_patch_settings_da.toml) |

Save your settings file to reload changes. Settings under `[patches]` require a full game restart.
4 changes: 4 additions & 0 deletions docs/FEATURES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Features

<p align="center">
<img src="https://repository-images.githubusercontent.com/693298224/6a87716f-3dbb-48a5-80e0-709e0a1ad133" alt="STFC Community Mod">
</p>

The mod adds controls and display options to the desktop game.
Change them in `community_patch_settings.toml`; the
[English example](configuration/example_community_patch_settings_en.toml) lists the settings and defaults.
Expand Down
4 changes: 4 additions & 0 deletions docs/IL2CPP.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# IL2CPP binding reference

<p align="center">
<img src="https://repository-images.githubusercontent.com/693298224/6a87716f-3dbb-48a5-80e0-709e0a1ad133" alt="STFC Community Mod">
</p>

The mod calls generated IL2CPP code through typed C++ bindings.
Bindings resolve members on first use, check metadata types, and cache the result for the process.
Runtime initialization must happen before resolution.
Expand Down
4 changes: 4 additions & 0 deletions docs/IL2CPP_SHUTDOWN_VALIDATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# macOS runtime shutdown hook validation

<p align="center">
<img src="https://repository-images.githubusercontent.com/693298224/6a87716f-3dbb-48a5-80e0-709e0a1ad133" alt="STFC Community Mod">
</p>

Client: `1.000.53284` (`100053284`), inspected 14 November 2026.
GameAssembly.dylib SHA-256: `a17be3929bc7545b2537093586d971ad800fe9ef4fe15a22063936b731491108`.

Expand Down
Loading
Loading