chore: update .gitignore, docs, compile script, and mod source/config (#3)

- .gitignore: ignore FactionRelationships-*/ and FactionRelationships-*.zip at repo root
- COMPILATION.md, compile.bat, README: doc and build updates
- Mod: LunaSettings.csv, mod_info.json, Java plugin/UI/input/change listener updates
- Remove obsolete FactionRelationshipsPackage config and mod_info

Made-with: Cursor

Author: iHateCode

.gitignore

@@ -4,7 +4,9 @@
 # Developer config (copy compile.local.example.bat to compile.local.bat and set your paths)
 FactionRelationships/compile.local.bat
 
-# Build output (from compile.bat; folder and zip include version from mod_info.json)
+# Build output (compile.bat writes to dist/; folder and zip include version from mod_info.json)
+dist/
+# Legacy or alternate build output at repo root (versioned folder and zip)
 FactionRelationships-*/
 FactionRelationships-*.zip
 

FactionRelationships/COMPILATION.md

@@ -48,7 +48,7 @@ FactionRelationships/
 └── COMPILATION.md
 ```
 
-Output: `FactionRelationships-<version>/` (folder and zip), where `<version>` comes from `mod_info.json`. Contains `classes/`, `jars/FactionRelationships.jar`, `config/`, and `data/`. In-game settings and keybind are configured via **Mod Settings** (F2 in campaign) under this mod's section.
+Output: written to **`dist/`** at the repo root (gitignored). The build produces `dist/FactionRelationships-<version>/` (folder) and `dist/FactionRelationships-<version>.zip`, where `<version>` comes from `mod_info.json`. Each package contains `classes/`, `jars/FactionRelationships.jar`, `config/`, and `data/`. In-game settings and keybind are configured via **Mod Settings** (F2 in campaign) under this mod's section.
 
 ## Compile
 
@@ -74,13 +74,13 @@ Set `GAME_DIR` (and optionally `LUNALIB`, `LAZYLIB`) before running (e.g. via `c
 
 ## Package and Install
 
-1. The build script copies `mod_info.json` and config into the versioned package folder (e.g. `FactionRelationships-1.0.0/`).
+1. The build script copies `mod_info.json` and config into the versioned package folder under `dist/` (e.g. `dist/FactionRelationships-1.0.0/`).
 2. Copy that folder into your game `mods` folder, then rename to `FactionRelationships` for the game to load it, or use the zip:
 
    ```
-   xcopy /E /I FactionRelationships-1.0.0 "YOUR_STARSECTOR_PATH\mods\FactionRelationships\"
+   xcopy /E /I dist\FactionRelationships-1.0.0 "YOUR_STARSECTOR_PATH\mods\FactionRelationships\"
    ```
-   Or extract `FactionRelationships-1.0.0.zip` into `mods` and rename the extracted folder to `FactionRelationships`.
+   Or extract `dist/FactionRelationships-1.0.0.zip` into `mods` and rename the extracted folder to `FactionRelationships`.
 
 3. Final layout in your game `mods` folder:
 
@@ -96,10 +96,10 @@ Set `GAME_DIR` (and optionally `LUNALIB`, `LAZYLIB`) before running (e.g. via `c
        └── FactionRelationships.jar
    ```
 
-   Configure max factions, text size, overlay keybind (toggle or hold), hostile-only filter, relationship-change display, and auto-show overlay on change in **Mod Settings** (F2 in campaign).
+   Configure max factions, text size, overlay keybind (toggle or hold), hostile-only filter, show-only-factions-in-current-system (and hyperspace fallback), relationship-change display, auto-show overlay on change, and optional auto-hide overlay after N seconds in **Mod Settings** (F2 in campaign).
 
 ## Quick Reference
 
 - **Game directory**: Set `GAME_DIR` in `compile.local.bat` (recommended) or in `compile.bat` / manual commands. Optionally set `LUNALIB` and `LAZYLIB` in `compile.local.bat` if you use versioned LunaLib/LazyLib folders.
 - **Source**: `FactionRelationships/src/com/factionrelationships/`
-- **Output**: `FactionRelationships-<version>/` and `FactionRelationships-<version>.zip` (version from `mod_info.json`); JAR at `jars/FactionRelationships.jar` inside the package.
+- **Output**: `dist/FactionRelationships-<version>/` and `dist/FactionRelationships-<version>.zip` (version from `mod_info.json`); JAR at `jars/FactionRelationships.jar` inside the package. The `dist/` folder is gitignored.

FactionRelationships/compile.bat

@@ -25,13 +25,15 @@ if not exist "%LAZYLIB%" (
 REM Read version from mod_info.json for package and zip names
 for /f "delims=" %%v in ('powershell -NoProfile -Command "(Get-Content '%~dp0mod_info.json' -Raw | ConvertFrom-Json).version"') do set VERSION=%%v
 set PKG=FactionRelationships-%VERSION%
+set DIST=..\dist
 
 set SRC=src\com\factionrelationships
-set OUT=..\%PKG%\classes
-set JAR=..\%PKG%\jars\FactionRelationships.jar
+set OUT=%DIST%\%PKG%\classes
+set JAR=%DIST%\%PKG%\jars\FactionRelationships.jar
 
+if not exist "%DIST%" mkdir "%DIST%"
 if not exist "%OUT%" mkdir "%OUT%"
-if not exist "..\%PKG%\jars" mkdir "..\%PKG%\jars"
+if not exist "%DIST%\%PKG%\jars" mkdir "%DIST%\%PKG%\jars"
 
 echo Compiling...
 javac -encoding UTF-8 -cp "%CORE%\starfarer.api.jar;%CORE%\starfarer_obf.jar;%CORE%\json.jar;%CORE%\log4j-1.2.9.jar;%CORE%\lwjgl.jar;%CORE%\lwjgl_util.jar;%LAZYLIB%;%LUNALIB%" -d "%OUT%" "%SRC%\FactionRelationshipsPlugin.java" "%SRC%\FactionRelationshipsUIRenderer.java" "%SRC%\FactionRelationshipsCampaignInputListener.java" "%SRC%\FactionRelationshipsKeybindScript.java" "%SRC%\FactionRelationshipChangeListener.java" "%SRC%\RelationshipChangeStore.java" "%SRC%\SystemFactionRelationshipsIntel.java"
@@ -48,11 +50,11 @@ if errorlevel 1 (
 )
 
 echo Copying mod_info.json, config, and data to package...
-copy /Y "mod_info.json" "..\%PKG%\mod_info.json" >nul
-if exist "config" xcopy /E /I /Y "config" "..\%PKG%\config" >nul
-if exist "data" xcopy /E /I /Y "data" "..\%PKG%\data" >nul
+copy /Y "mod_info.json" "%DIST%\%PKG%\mod_info.json" >nul
+if exist "config" xcopy /E /I /Y "config" "%DIST%\%PKG%\config" >nul
+if exist "data" xcopy /E /I /Y "data" "%DIST%\%PKG%\data" >nul
 
 echo Creating %PKG%.zip...
-powershell -NoProfile -Command "Compress-Archive -Path '..\%PKG%' -DestinationPath '..\%PKG%.zip' -Force"
+powershell -NoProfile -Command "Compress-Archive -Path '%DIST%\%PKG%' -DestinationPath '%DIST%\%PKG%.zip' -Force"
 
-echo Done. Install by copying %PKG% to Starsector\mods\FactionRelationships\ (or extract %PKG%.zip into mods)
+echo Done. Output in dist\%PKG%\ and dist\%PKG%.zip. Install by copying to Starsector\mods\FactionRelationships\ (or extract the zip into mods)

FactionRelationships/data/config/LunaSettings.csv

@@ -1,10 +1,12 @@
 fieldID,fieldName,fieldType,defaultValue,secondaryValue,fieldDescription,minValue,maxValue,tab
-factionRelationshipsHeader,Faction Relationships,Header,Faction Relationships,,,,,General
 maxFactions,Max Factions Shown,Int,15,,Maximum number of factions to display in the overlay (sorted by relationship).,1,50,General
 showOnlyHostile,Show Only Hostile Factions,Boolean,false,,Only display factions with reputation -50 or worse (Hostile/Inhospitable). Helps focus on immediate threats.,,,General
+showOnlyFactionsInSystem,Show Only Factions in Current System,Boolean,false,,Only show factions that have a market in the current star system. In hyperspace, behavior is controlled by the option below.,,,General
+showFullListInHyperspace,In Hyperspace: Show Full List,Boolean,true,,When "Show only factions in current system" is on, in hyperspace show the full faction list instead of none. Reduces clutter in-system while avoiding an empty overlay while traveling.,,,General
 textSize,Text Size,Radio,Medium,"Small,Medium,Large",Text size for the overlay. Use [Large] for 4K or high-DPI displays.,,,General
 overlayKeybindMode,Overlay Keybind Mode,Radio,Toggle,"Toggle,Hold",[Toggle]: Press key to show or hide overlay. [Hold]: Overlay only visible while key is held.,,,General
-toggleOverlayKeybind,Toggle Overlay Keybind,Keycode,0,,Key to show or hide the faction relationship overlay on the campaign map. Set in Mod Settings (F2). Keycode 0 = unbound.,,,General
+toggleOverlayKeybind,Toggle Overlay Keybind,Keycode,66,,Key to show or hide the faction relationship overlay on the campaign map. Set in Mod Settings (F2). Keycode 0 = unbound. Default: B.,,,General
 showRelationshipChangeInOverlay,Show Relationship Change in Overlay,Boolean,true,,"When a faction relationship changes, show the change (e.g. +5 or -10) next to that faction for the duration set below.",,,General
-relationshipChangeDisplaySeconds,Relationship Change Display (seconds),Int,30,,"How long to show the change next to a faction in the overlay, in seconds.",5,120,General
-autoShowOverlayOnRelationshipChange,Auto-Show Overlay When Relationship Changes,Boolean,false,,"When a faction relationship changes, automatically show the overlay (for the duration set above).",,,General
+relationshipChangeDisplaySeconds,Relationship Change Display (seconds),Int,10,,"How long to show the change next to a faction in the overlay, in seconds.",5,120,General
+autoShowOverlayOnRelationshipChange,Auto-Show Overlay When Relationship Changes,Boolean,true,,"When a faction relationship changes, automatically show the overlay (for the duration set above).",,,General
+autoHideOverlayAfterSeconds,Auto-Hide Overlay After (seconds),Int,10,,"0 = overlay stays until you hide it (relationship-change auto-show still uses the duration above). When > 0, overlay auto-hides after this many seconds whenever it is shown (hotkey, location change, or relationship change).",0,300,General

FactionRelationships/mod_info.json

@@ -2,7 +2,7 @@
     "id": "factionrelationships",
     "name": "Faction Relationships",
     "author": "boop",
-    "version": "1.4.8",
+    "version": "1.5.9",
     "description": "Shows a list of factions and their relationship with the player on the main navigation screen.",
     "gameVersion": "0.98a-RC8",
     "jars": ["jars/FactionRelationships.jar"],

FactionRelationships/src/com/factionrelationships/FactionRelationshipChangeListener.java

@@ -43,7 +43,9 @@ public void reportPlayerReputationChange(String factionId, float delta) {
             Boolean autoShow = LunaSettings.getBoolean(FactionRelationshipsPlugin.MOD_ID, AUTO_SHOW_SETTING);
             if (Boolean.TRUE.equals(autoShow)) {
                 FactionRelationshipsPlugin.setOverlayVisible(true);
-                RelationshipChangeStore.setAutoShowExpiry(System.currentTimeMillis() + durationMs);
+                int autoHideSec = FactionRelationshipsPlugin.getAutoHideOverlayAfterSeconds();
+                long hideAfterMs = (autoHideSec > 0) ? (autoHideSec * 1000L) : durationMs;
+                RelationshipChangeStore.setAutoShowExpiry(System.currentTimeMillis() + hideAfterMs);
             }
         }
     }

FactionRelationships/src/com/factionrelationships/FactionRelationshipsCampaignInputListener.java

@@ -42,11 +42,18 @@ public void processCampaignInputPreCore(List<InputEventAPI> events) {
                 continue;
             }
             if (event.isKeyDownEvent() && event.getEventValue() == keycode) {
-                RelationshipChangeStore.clearAutoShowExpiry();
                 if ("Hold".equals(mode)) {
+                    RelationshipChangeStore.clearAutoShowExpiry();
                     FactionRelationshipsPlugin.setOverlayKeyHeld(true);
                 } else {
-                    FactionRelationshipsPlugin.setOverlayVisible(!FactionRelationshipsPlugin.isOverlayVisible());
+                    boolean willBeVisible = !FactionRelationshipsPlugin.isOverlayVisible();
+                    FactionRelationshipsPlugin.setOverlayVisible(willBeVisible);
+                    int autoHideSec = FactionRelationshipsPlugin.getAutoHideOverlayAfterSeconds();
+                    if (willBeVisible && autoHideSec > 0) {
+                        RelationshipChangeStore.setAutoShowExpiry(System.currentTimeMillis() + autoHideSec * 1000L);
+                    } else if (!willBeVisible) {
+                        RelationshipChangeStore.clearAutoShowExpiry();
+                    }
                 }
                 event.consume();
                 break;

FactionRelationships/src/com/factionrelationships/FactionRelationshipsPlugin.java

@@ -59,6 +59,19 @@ public static boolean isLunaLibEnabled() {
         return Global.getSettings().getModManager().isModEnabled("lunalib");
     }
 
+    /** Seconds after which to auto-hide the overlay when shown (0 = only relationship-change uses its duration). */
+    public static int getAutoHideOverlayAfterSeconds() {
+        if (!isLunaLibEnabled()) {
+            return 0;
+        }
+        Integer v = LunaSettings.getInt(MOD_ID, "autoHideOverlayAfterSeconds");
+        if (v == null || v.intValue() <= 0) {
+            return 0;
+        }
+        int sec = Math.min(300, v.intValue());
+        return sec;
+    }
+
     /** Called when LunaSettings change so mode and other caches are re-read. */
     public static void invalidateSettingsCache() {
         cachedOverlayKeybindMode = null;

FactionRelationships/src/com/factionrelationships/FactionRelationshipsUIRenderer.java

@@ -2,6 +2,7 @@
 
 import com.fs.starfarer.api.Global;
 import com.fs.starfarer.api.campaign.FactionAPI;
+import com.fs.starfarer.api.campaign.LocationAPI;
 import com.fs.starfarer.api.campaign.econ.EconomyAPI;
 import com.fs.starfarer.api.campaign.econ.MarketAPI;
 import com.fs.starfarer.api.campaign.listeners.CampaignUIRenderingListener;
@@ -37,15 +38,29 @@ public class FactionRelationshipsUIRenderer implements CampaignUIRenderingListen
     private static Integer cachedMaxFactions = null;
     private static Boolean cachedShowOnlyHostile = null;
     private static Boolean cachedShowRelationshipChangeInOverlay = null;
+    private static Boolean cachedShowOnlyFactionsInSystem = null;
+    private static Boolean cachedShowFullListInHyperspace = null;
     private static String cachedFont = null;
     private static Float cachedLineHeight = null;
 
+    /** Cache for "show only in system": only rebuild when location or settings change. */
+    private static LocationAPI cachedFactionIdsLocation = null;
+    private static Set<String> cachedFactionIdsForLocation = null;
+
+    /** When "show only in system" is on (Toggle mode), we auto-show the overlay when location changes. */
+    private static LocationAPI lastSeenLocationForAutoShow = null;
+
     public static void invalidateSettingsCache() {
         cachedMaxFactions = null;
         cachedShowOnlyHostile = null;
         cachedShowRelationshipChangeInOverlay = null;
+        cachedShowOnlyFactionsInSystem = null;
+        cachedShowFullListInHyperspace = null;
         cachedFont = null;
         cachedLineHeight = null;
+        cachedFactionIdsLocation = null;
+        cachedFactionIdsForLocation = null;
+        lastSeenLocationForAutoShow = null;
     }
 
     private static boolean getShowRelationshipChangeInOverlay() {
@@ -78,6 +93,36 @@ private static boolean getShowOnlyHostile() {
         return value;
     }
 
+    private static boolean getShowOnlyFactionsInSystem() {
+        if (cachedShowOnlyFactionsInSystem != null) {
+            return cachedShowOnlyFactionsInSystem.booleanValue();
+        }
+        boolean value = false;
+        if (FactionRelationshipsPlugin.isLunaLibEnabled()) {
+            Boolean v = LunaSettings.getBoolean(FactionRelationshipsPlugin.MOD_ID, "showOnlyFactionsInSystem");
+            if (v != null) {
+                value = v.booleanValue();
+            }
+        }
+        cachedShowOnlyFactionsInSystem = Boolean.valueOf(value);
+        return value;
+    }
+
+    private static boolean getShowFullListInHyperspace() {
+        if (cachedShowFullListInHyperspace != null) {
+            return cachedShowFullListInHyperspace.booleanValue();
+        }
+        boolean value = true;
+        if (FactionRelationshipsPlugin.isLunaLibEnabled()) {
+            Boolean v = LunaSettings.getBoolean(FactionRelationshipsPlugin.MOD_ID, "showFullListInHyperspace");
+            if (v != null) {
+                value = v.booleanValue();
+            }
+        }
+        cachedShowFullListInHyperspace = Boolean.valueOf(value);
+        return value;
+    }
+
     private static int getMaxFactions() {
         if (cachedMaxFactions != null) {
             return cachedMaxFactions.intValue();
@@ -131,6 +176,52 @@ private static FontAndLineHeight getFontAndLineHeight() {
         return new FontAndLineHeight(font, lineHeight);
     }
 
+    private static Set<String> buildSetFromAllMarkets() {
+        Set<String> out = new HashSet<String>();
+        EconomyAPI economy = Global.getSector().getEconomy();
+        if (economy != null) {
+            for (MarketAPI market : economy.getMarketsCopy()) {
+                if (market.getFaction() != null) {
+                    out.add(market.getFactionId());
+                }
+            }
+        }
+        return out;
+    }
+
+    private static Set<String> getFactionIdsToShow() {
+        if (!getShowOnlyFactionsInSystem()) {
+            return buildSetFromAllMarkets();
+        }
+
+        LocationAPI loc = Global.getSector().getPlayerFleet().getContainingLocation();
+        if (loc == null || loc.isHyperspace()) {
+            if (getShowFullListInHyperspace()) {
+                return buildSetFromAllMarkets();
+            }
+            return new HashSet<String>();
+        }
+
+        if (loc == cachedFactionIdsLocation && cachedFactionIdsForLocation != null) {
+            return cachedFactionIdsForLocation;
+        }
+        Set<String> factionIds = new HashSet<String>();
+        EconomyAPI economy = Global.getSector().getEconomy();
+        if (economy != null) {
+            List<MarketAPI> marketsInLoc = economy.getMarkets(loc);
+            if (marketsInLoc != null) {
+                for (MarketAPI market : marketsInLoc) {
+                    if (market != null && market.getFaction() != null) {
+                        factionIds.add(market.getFactionId());
+                    }
+                }
+            }
+        }
+        cachedFactionIdsLocation = loc;
+        cachedFactionIdsForLocation = factionIds;
+        return factionIds;
+    }
+
     @Override
     public void renderInUICoordsBelowUI(ViewportAPI viewport) {
         // no-op; draw above UI
@@ -158,22 +249,25 @@ private void renderPanel(ViewportAPI viewport) {
             RelationshipChangeStore.clearAutoShowExpiry();
         }
         String mode = FactionRelationshipsPlugin.getOverlayKeybindMode();
+        if (getShowOnlyFactionsInSystem() && "Toggle".equals(mode)) {
+            LocationAPI loc = Global.getSector().getPlayerFleet().getContainingLocation();
+            if (loc != lastSeenLocationForAutoShow) {
+                FactionRelationshipsPlugin.setOverlayVisible(true);
+                int autoHideSec = FactionRelationshipsPlugin.getAutoHideOverlayAfterSeconds();
+                if (autoHideSec > 0) {
+                    RelationshipChangeStore.setAutoShowExpiry(System.currentTimeMillis() + autoHideSec * 1000L);
+                }
+            }
+            lastSeenLocationForAutoShow = loc;
+        }
         boolean showOverlay = "Hold".equals(mode)
             ? FactionRelationshipsPlugin.isOverlayKeyHeld()
             : FactionRelationshipsPlugin.isOverlayVisible();
         if (!showOverlay) {
             return;
         }
 
-        Set<String> factionIdsWithMarkets = new HashSet<String>();
-        EconomyAPI economy = Global.getSector().getEconomy();
-        if (economy != null) {
-            for (MarketAPI market : economy.getMarketsCopy()) {
-                if (market.getFaction() != null) {
-                    factionIdsWithMarkets.add(market.getFactionId());
-                }
-            }
-        }
+        Set<String> factionIdsWithMarkets = getFactionIdsToShow();
 
         List<FactionAPI> factions = new ArrayList<FactionAPI>();
         for (FactionAPI faction : Global.getSector().getAllFactions()) {