Faction Relationships

A Starsector mod that shows a list of factions and their relationship with the player on the main navigation screen.

• Game version: 0.98a-RC8
• Mod ID: factionrelationships
• Dependencies: LazyLib and LunaLib (required; enable them in the launcher).

Installation

1. Install LazyLib and LunaLib in your Starsector mods folder if you have not already.
2. Download the latest release (or build from source; see below).
3. Extract the mod folder into your Starsector mods directory.
4. Enable the mod (and LazyLib, LunaLib) in the game launcher.

Your mods folder should contain something like:

mods/FactionRelationships/
├── mod_info.json
├── config/
│   └── faction_relationships_config.json   # deprecated; settings via Mod Settings
├── data/
│   └── config/
│       └── LunaSettings.csv
└── jars/
    └── FactionRelationships.jar

Configuration

Configure the mod in-game via Mod Settings (press F2 in campaign): max factions shown, text size, overlay keybind (toggle or hold-to-view), and optional “show only hostile factions” filter, optional "show only factions in current system" (and in hyperspace: show full list or none), relationship-change display in overlay (duration configurable, default 30 seconds), optional auto-show overlay when a relationship changes, and optional auto-hide overlay after a set number of seconds (when > 0, applies whenever the overlay is shown: hotkey, location change, or relationship change). No need to edit JSON files.

Version Checker release checklist

Use this checklist for every release so update checks keep working:

1. Keep versions in sync:

• FactionRelationships/mod_info.json -> "version": "X.Y.Z"
• FactionRelationships/FactionRelationships.version -> modVersion.major/minor/patch = X/Y/Z

2. Keep masterVersionFile in FactionRelationships/FactionRelationships.version pointing to the raw GitHub URL for that same file on your default branch.
3. Ensure the mod package includes both:

• FactionRelationships/FactionRelationships.version
• FactionRelationships/data/config/version/version_files.csv with:

version file
FactionRelationships.version

4. Build with FactionRelationships/compile.bat (this produces both dist/FactionRelationships-X.Y.Z.zip and dist/FactionRelationships.zip).
5. Attach FactionRelationships.zip to the GitHub release if directDownloadURL uses .../releases/latest/download/FactionRelationships.zip.
6. Publish the release tag matching the same version (vX.Y.Z) so local installs can detect an update correctly.

Building from source

• Requirements: JDK 17, a Starsector 0.98a install (for API JARs), and LunaLib and LazyLib installed in your game mods folder (the build script needs their JARs).
• Build: From the repo root, run FactionRelationships\compile.bat.
  Copy FactionRelationships\compile.local.example.bat to FactionRelationships\compile.local.bat and set GAME_DIR to your Starsector path (and optionally LUNALIB / LAZYLIB if you use versioned mod folders).
• Details: See FactionRelationships/COMPILATION.md for full build steps, project layout, and manual compile commands.

License

This project is licensed under the MIT License — see the LICENSE file.