Skip to content

Commit 869fd86

Browse files
committed
Add Version Checker support and release checklist
- Add version_files.csv to register .version file with Version Checker - Update compile.bat to generate stable FactionRelationships.zip for releases - Add Version Checker release checklist to README with repeatable steps - Update init rule to require reading README and COMPILATION docs at startup
1 parent 63da16e commit 869fd86

3 files changed

Lines changed: 26 additions & 0 deletions

File tree

FactionRelationships/compile.bat

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,7 @@ if exist "data" xcopy /E /I /Y "data" "%DIST%\%PKG%\data" >nul
5858
echo Creating %PKG%.zip...
5959
powershell -NoProfile -Command "Compress-Archive -Path '%DIST%\%PKG%' -DestinationPath '%DIST%\%PKG%.zip' -Force"
6060

61+
echo Creating FactionRelationships.zip...
62+
powershell -NoProfile -Command "Compress-Archive -Path '%DIST%\%PKG%' -DestinationPath '%DIST%\FactionRelationships.zip' -Force"
63+
6164
echo Done. Output in dist\%PKG%\ and dist\%PKG%.zip. Install by copying to Starsector\mods\FactionRelationships\ (or extract the zip into mods)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
version file
2+
FactionRelationships.version

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,27 @@ mods/FactionRelationships/
3333

3434
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.
3535

36+
## Version Checker release checklist
37+
38+
Use this checklist for every release so update checks keep working:
39+
40+
1. Keep versions in sync:
41+
- `FactionRelationships/mod_info.json` -> `"version": "X.Y.Z"`
42+
- `FactionRelationships/FactionRelationships.version` -> `modVersion.major/minor/patch = X/Y/Z`
43+
2. Keep `masterVersionFile` in `FactionRelationships/FactionRelationships.version` pointing to the raw GitHub URL for that same file on your default branch.
44+
3. Ensure the mod package includes both:
45+
- `FactionRelationships/FactionRelationships.version`
46+
- `FactionRelationships/data/config/version/version_files.csv` with:
47+
48+
```csv
49+
version file
50+
FactionRelationships.version
51+
```
52+
53+
4. Build with `FactionRelationships/compile.bat` (this produces both `dist/FactionRelationships-X.Y.Z.zip` and `dist/FactionRelationships.zip`).
54+
5. Attach `FactionRelationships.zip` to the GitHub release if `directDownloadURL` uses `.../releases/latest/download/FactionRelationships.zip`.
55+
6. Publish the release tag matching the same version (`vX.Y.Z`) so local installs can detect an update correctly.
56+
3657
## Building from source
3758

3859
- **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).

0 commit comments

Comments
 (0)