feat: LunaLib integration, overlay options, and docs (#1)

- Add LunaLib/LazyLib dependency; settings via LunaSettings (Mod Settings F2)
- Config: max factions, text size (Small/Medium/Large), overlay keybind (Toggle/Hold), hostile-only filter
- FactionRelationshipsKeybindScript for overlay toggle/hold; fix EveryFrameScript import
- Build: optional LUNALIB/LAZYLIB in compile.local.bat for versioned mod folders
- Bump font sizes (Large uses ORBITRON_20AA, 24px line)
- Update README, COMPILATION.md, compile.local.example.bat

Author: iHateCode

FactionRelationships/COMPILATION.md

@@ -7,18 +7,21 @@
 - **Mod ID**: `factionrelationships`
 - **Game Version**: `0.98a-RC8`
 - **Mod Plugin**: `com.factionrelationships.FactionRelationshipsPlugin`
+- **Dependencies**: LazyLib and LunaLib (required at runtime and for compilation).
 
 ## Prerequisites
 
 1. **JDK 17** – Starsector 0.98a uses Java 17. Install JDK 17 and run `javac -version`.
 2. **Starsector** – JARs are taken from your game install (the folder that contains `starsector-core`).
+3. **LunaLib and LazyLib** – Install both mods in your Starsector `mods` folder. The compile script looks for `mods/LunaLib/jars/LunaLib.jar` and `mods/LazyLib/jars/LazyLib.jar` by default. If your mod folders use versioned names (e.g. `LunaLib-2.0.5`, `LazyLib-3.0.0`), set `LUNALIB` and `LAZYLIB` in `compile.local.bat` to point at those JARs (see Developer config below). Required for compilation and at runtime.
 
 ## Developer config (optional)
 
 To avoid editing `compile.bat` and to keep your local paths out of the repo:
 
 1. Copy `FactionRelationships/compile.local.example.bat` to `FactionRelationships/compile.local.bat`.
 2. Edit `compile.local.bat` and set `GAME_DIR` to your Starsector install directory.
+3. If LunaLib or LazyLib use versioned folder names (e.g. `LunaLib-2.0.5`), set `LUNALIB` and `LAZYLIB` to the full paths to their JARs so the build can find them.
 
 `compile.local.bat` is gitignored; only the example file is committed. The main `compile.bat` loads it automatically when present.
 
@@ -28,16 +31,20 @@ To avoid editing `compile.bat` and to keep your local paths out of the repo:
 FactionRelationships/
 ├── mod_info.json
 ├── config/
-│   └── faction_relationships_config.json   # optional: maxFactions (default 15, clamped 1–50)
+│   └── faction_relationships_config.json   # deprecated; settings via LunaLib (see data/config)
+├── data/
+│   └── config/
+│       └── LunaSettings.csv   # LunaLib settings (max factions, text size, overlay keybind)
 ├── src/
 │   └── com/factionrelationships/
 │       ├── FactionRelationshipsPlugin.java
-│       └── FactionRelationshipsUIRenderer.java
+│       ├── FactionRelationshipsUIRenderer.java
+│       └── FactionRelationshipsKeybindScript.java
 ├── compile.local.example.bat   # copy to compile.local.bat (gitignored) to set GAME_DIR
 └── COMPILATION.md
 ```
 
-Output: `FactionRelationships-<version>/` (folder and zip), where `<version>` comes from `mod_info.json` (e.g. `FactionRelationships-1.0.0/`, `FactionRelationships-1.0.0.zip`). Contains `classes/`, `jars/FactionRelationships.jar`, and `config/`.
+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.
 
 ## Compile
 
@@ -47,17 +54,19 @@ From the repo root, run the build script:
 FactionRelationships\compile.bat
 ```
 
-Or manually:
+Or manually (set `LUNALIB` and `LAZYLIB` if using versioned mod folders):
 
 ```batch
 set GAME_DIR=YOUR_STARSECTOR_PATH
+set LUNALIB=%GAME_DIR%\mods\LunaLib\jars\LunaLib.jar
+set LAZYLIB=%GAME_DIR%\mods\LazyLib\jars\LazyLib.jar
 set CORE=%GAME_DIR%\starsector-core
-set VERSION=1.0.0
-javac -encoding UTF-8 -cp "%CORE%\starfarer.api.jar;%CORE%\starfarer_obf.jar;%CORE%\log4j-1.2.9.jar;%CORE%\lwjgl.jar;%CORE%\lwjgl_util.jar" -d FactionRelationships-%VERSION%\classes FactionRelationships\src\com\factionrelationships\*.java
+set VERSION=1.3.0
+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 FactionRelationships-%VERSION%\classes FactionRelationships\src\com\factionrelationships\FactionRelationshipsPlugin.java FactionRelationships\src\com\factionrelationships\FactionRelationshipsUIRenderer.java FactionRelationships\src\com\factionrelationships\FactionRelationshipsKeybindScript.java
 jar cvf FactionRelationships-%VERSION%\jars\FactionRelationships.jar -C FactionRelationships-%VERSION%\classes .
 ```
 
-Set `GAME_DIR` before running (e.g. via `compile.local.bat` as above, or in the batch session).
+Set `GAME_DIR` (and optionally `LUNALIB`, `LAZYLIB`) before running (e.g. via `compile.local.bat` as above, or in the batch session).
 
 ## Package and Install
 
@@ -76,14 +85,17 @@ Set `GAME_DIR` before running (e.g. via `compile.local.bat` as above, or in the
    ├── mod_info.json
    ├── config\
    │   └── faction_relationships_config.json
+   ├── data\
+   │   └── config\
+   │       └── LunaSettings.csv
    └── jars\
        └── FactionRelationships.jar
    ```
 
-   To change how many factions are shown, edit `config/faction_relationships_config.json` and set `maxFactions` (1–50). Default is 15.
+   Configure max factions, text size, overlay keybind (toggle or hold), and hostile-only filter in **Mod Settings** (F2 in campaign).
 
 ## Quick Reference
 
-- **Game directory**: Set `GAME_DIR` in `compile.local.bat` (recommended) or in `compile.bat` / manual commands.
+- **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.

FactionRelationships/compile.bat

@@ -4,11 +4,23 @@ if exist "%~dp0compile.local.bat" call "%~dp0compile.local.bat"
 if not defined GAME_DIR set GAME_DIR=YOUR_STARSECTOR_PATH
 
 set CORE=%GAME_DIR%\starsector-core
+if not defined LUNALIB set LUNALIB=%GAME_DIR%\mods\LunaLib\jars\LunaLib.jar
+if not defined LAZYLIB set LAZYLIB=%GAME_DIR%\mods\LazyLib\jars\LazyLib.jar
 if not exist "%CORE%\starfarer.api.jar" (
     echo Error: Starsector path not found.
     echo Copy FactionRelationships\compile.local.example.bat to compile.local.bat and set GAME_DIR to your Starsector install directory.
     exit /b 1
 )
+if not exist "%LUNALIB%" (
+    echo Error: LunaLib not found at %LUNALIB%
+    echo Install LunaLib in your Starsector mods folder to compile.
+    exit /b 1
+)
+if not exist "%LAZYLIB%" (
+    echo Error: LazyLib not found at %LAZYLIB%
+    echo Install LazyLib in your Starsector mods folder to compile.
+    exit /b 1
+)
 
 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
@@ -22,7 +34,7 @@ if not exist "%OUT%" mkdir "%OUT%"
 if not exist "..\%PKG%\jars" mkdir "..\%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" -d "%OUT%" "%SRC%\FactionRelationshipsPlugin.java" "%SRC%\FactionRelationshipsUIRenderer.java"
+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%\FactionRelationshipsKeybindScript.java"
 if errorlevel 1 (
     echo Compilation failed.
     exit /b 1
@@ -35,9 +47,10 @@ if errorlevel 1 (
     exit /b 1
 )
 
-echo Copying mod_info.json and config to package...
+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
 
 echo Creating %PKG%.zip...
 powershell -NoProfile -Command "Compress-Archive -Path '..\%PKG%' -DestinationPath '..\%PKG%.zip' -Force"

FactionRelationships/compile.local.example.bat

@@ -3,3 +3,7 @@ REM Copy this file to compile.local.bat and set your paths.
 REM compile.local.bat is gitignored and will be used by compile.bat when present.
 
 set GAME_DIR=YOUR_STARSECTOR_PATH
+
+REM Optional: if LunaLib/LazyLib use versioned folder names (e.g. LunaLib-2.0.5), set these so the build finds the JARs:
+REM set LUNALIB=%GAME_DIR%\mods\LunaLib-2.0.5\jars\LunaLib.jar
+REM set LAZYLIB=%GAME_DIR%\mods\LazyLib-3.0.0\jars\LazyLib.jar

FactionRelationships/data/config/LunaSettings.csv

@@ -0,0 +1,7 @@
+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
+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

FactionRelationships/mod_info.json

@@ -2,9 +2,13 @@
     "id": "factionrelationships",
     "name": "Faction Relationships",
     "author": "boop",
-    "version": "1.0.0",
+    "version": "1.3.1",
     "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"],
-    "modPlugin": "com.factionrelationships.FactionRelationshipsPlugin"
+    "modPlugin": "com.factionrelationships.FactionRelationshipsPlugin",
+    "dependencies": [
+        {"id": "lw_lazylib", "name": "LazyLib"},
+        {"id": "lunalib", "name": "LunaLib"}
+    ]
 }

FactionRelationships/src/com/factionrelationships/FactionRelationshipsKeybindScript.java

@@ -0,0 +1,49 @@
+package com.factionrelationships;
+
+import com.fs.starfarer.api.Global;
+import com.fs.starfarer.api.EveryFrameScript;
+import lunalib.lunaSettings.LunaSettings;
+import org.lwjgl.input.Keyboard;
+
+/**
+ * Polls the LunaLib keybind. In Toggle mode: press to show/hide overlay (edge detection).
+ * In Hold mode: overlay visible only while key is held.
+ */
+public class FactionRelationshipsKeybindScript implements EveryFrameScript {
+
+    private boolean keyWasDown;
+
+    @Override
+    public boolean isDone() {
+        return false;
+    }
+
+    @Override
+    public boolean runWhilePaused() {
+        return false;
+    }
+
+    @Override
+    public void advance(float amount) {
+        if (!Global.getSettings().getModManager().isModEnabled("lunalib")) {
+            return;
+        }
+        Integer keycodeObj = LunaSettings.getInt("factionrelationships", "toggleOverlayKeybind");
+        if (keycodeObj == null || keycodeObj.intValue() == 0) {
+            FactionRelationshipsPlugin.setOverlayKeyHeld(false);
+            return;
+        }
+        int keycode = keycodeObj.intValue();
+        boolean keyDown = Keyboard.isKeyDown(keycode);
+        String mode = FactionRelationshipsPlugin.getOverlayKeybindMode();
+        if ("Hold".equals(mode)) {
+            FactionRelationshipsPlugin.setOverlayKeyHeld(keyDown);
+        } else {
+            FactionRelationshipsPlugin.setOverlayKeyHeld(false);
+            if (!keyWasDown && keyDown) {
+                FactionRelationshipsPlugin.setOverlayVisible(!FactionRelationshipsPlugin.isOverlayVisible());
+            }
+        }
+        keyWasDown = keyDown;
+    }
+}

FactionRelationships/src/com/factionrelationships/FactionRelationshipsPlugin.java

@@ -2,23 +2,85 @@
 
 import com.fs.starfarer.api.BaseModPlugin;
 import com.fs.starfarer.api.Global;
+import lunalib.lunaSettings.LunaSettings;
+import lunalib.lunaSettings.LunaSettingsListener;
 import org.apache.log4j.Logger;
 
 public class FactionRelationshipsPlugin extends BaseModPlugin {
 
     private static Logger log;
 
+    /** Overlay visibility toggle; read by renderer, written by keybind script (Toggle mode). Default true. */
+    private static volatile boolean overlayVisible = true;
+
+    /** Key currently held; used in Hold mode so overlay shows only while key is down. */
+    private static volatile boolean overlayKeyHeld = false;
+
+    /** Cached overlay keybind mode (Toggle vs Hold); invalidated when LunaSettings change. */
+    private static volatile String cachedOverlayKeybindMode = null;
+
+    public static boolean isOverlayVisible() {
+        return overlayVisible;
+    }
+
+    public static void setOverlayVisible(boolean visible) {
+        overlayVisible = visible;
+    }
+
+    public static boolean isOverlayKeyHeld() {
+        return overlayKeyHeld;
+    }
+
+    public static void setOverlayKeyHeld(boolean held) {
+        overlayKeyHeld = held;
+    }
+
+    /** Returns "Toggle" or "Hold"; default "Toggle" if unset or LunaLib disabled. */
+    public static String getOverlayKeybindMode() {
+        if (cachedOverlayKeybindMode != null) {
+            return cachedOverlayKeybindMode;
+        }
+        String mode = "Toggle";
+        if (Global.getSettings().getModManager().isModEnabled("lunalib")) {
+            String s = LunaSettings.getString("factionrelationships", "overlayKeybindMode");
+            if (s != null && ("Hold".equalsIgnoreCase(s) || "Toggle".equalsIgnoreCase(s))) {
+                mode = "Hold".equalsIgnoreCase(s) ? "Hold" : "Toggle";
+            }
+        }
+        cachedOverlayKeybindMode = mode;
+        return mode;
+    }
+
+    /** Called when LunaSettings change so mode and other caches are re-read. */
+    public static void invalidateSettingsCache() {
+        cachedOverlayKeybindMode = null;
+    }
+
     @Override
     public void onApplicationLoad() throws Exception {
         log = Global.getLogger(FactionRelationshipsPlugin.class);
         log.info("Faction Relationships mod loaded.");
+        if (Global.getSettings().getModManager().isModEnabled("lunalib")) {
+            LunaSettings.addSettingsListener(new LunaSettingsListener() {
+                @Override
+                public void settingsChanged(String modID) {
+                    if ("factionrelationships".equals(modID)) {
+                        FactionRelationshipsPlugin.invalidateSettingsCache();
+                        FactionRelationshipsUIRenderer.invalidateSettingsCache();
+                    }
+                }
+            });
+        }
     }
 
     @Override
     public void onGameLoad(boolean newGame) {
         Global.getSector().getListenerManager().addListener(new FactionRelationshipsUIRenderer(), true);
+        if (Global.getSettings().getModManager().isModEnabled("lunalib")) {
+            Global.getSector().addScript(new FactionRelationshipsKeybindScript());
+        }
         if (log != null) {
-            log.info("Faction Relationships UI renderer registered.");
+            log.info("Faction Relationships UI renderer and keybind script registered.");
         }
     }
 }