Initial release: HSRTools 1.0.0 - auto-invite on trigger word in FC/LS/CWLS/tells

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-02 23:45:22 -05:00
commit 33088ea6e5
16 changed files with 849 additions and 0 deletions
@@ -0,0 +1,49 @@
+# Releasing HSRTools
+
+## 1. Version and changelog
+
+- Bump `<Version>` in `HSRTools/HSRTools.csproj` (e.g. `1.0.0.0` → `1.0.1.0`).
+- Update `CHANGELOG.md` with the new version and date.
+
+## 2. Build
+
+```bash
+dotnet build HSRTools.sln -c Release
+```
+
+## 3. Create release zip
+
+Zip the **contents** of `HSRTools/bin/Release/HSRTools/` (so the zip contains `HSRTools.dll` and `HSRTools.json` at the root), and name it `HSRTools.zip`.
+
+- **Windows (PowerShell):**  
+  `Compress-Archive -Path "HSRTools\bin\Release\HSRTools\*" -DestinationPath "HSRTools.zip"`
+- **From repo root:**  
+  Run the above from the repo root so the archive has no extra folder layer.
+
+## 4. GitHub release
+
+1. Push your commits and ensure `main` is up to date.
+2. Create a new release: **Releases** → **Draft a new release**.
+3. **Tag:** `v1.0.0` (match the version, e.g. `v1.0.0.0` or `v1.0.0`).
+4. **Title:** e.g. `v1.0.0` or `HSRTools 1.0.0`.
+5. **Description:** Paste the relevant section from `CHANGELOG.md`.
+6. Attach `HSRTools.zip`.
+7. Publish the release.
+
+## 5. pluginmaster.json (for third-party repo)
+
+If you host your own plugin list:
+
+- Set `AssemblyVersion` to the same version (e.g. `1.0.0.0`).
+- Set `LastUpdate` to current Unix timestamp (e.g. `date +%s` or [epoch converter](https://www.epochconverter.com/)).
+- Set `DownloadLinkInstall` and `DownloadLinkUpdate` to the zip URL, e.g.:  
+  `https://github.com/Knack117/HSRTools/releases/download/v1.0.0/HSRTools.zip`
+- Host `pluginmaster.json` at a stable URL and add that URL as a “custom plugin repository” in XIVLauncher → Dalamud Settings.
+
+## 6. Official Dalamud repo (optional)
+
+To get HSRTools on the main Dalamud plugin list:
+
+1. Open [goatcorp/DalamudPlugins](https://github.com/goatcorp/DalamudPlugins) and check their README and `pluginmaster.json` format.
+2. Fork, add your plugin (or a manifest entry pointing to your repo), and open a PR.
+3. They may host the zip on their CDN; follow their instructions for new plugins.