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,62 @@
+# HSRTools
+
+A [Dalamud](https://github.com/goatcorp/Dalamud) plugin for FFXIV (XIVLauncher) that automatically invites players to your party when they say a specific trigger word or phrase in chat.
+
+## Features
+
+- **Configurable trigger text** – Set any word or phrase (e.g. `inv`, `invite`, `party`). When someone types it in a monitored channel, they are invited to your party.
+- **Channel selection** – Choose which channels to monitor:
+  - Free Company
+  - Link Shell (1–8)
+  - Cross-World Link Shell (1–8)
+  - Tells / Whispers
+- **Case sensitivity** – Option to match the trigger with or without case sensitivity.
+- **Enable/disable** – Turn the plugin on or off without uninstalling.
+
+## How it works
+
+1. You set a trigger word in the plugin configuration (default: `inv`).
+2. The plugin listens to chat in the channels you enable (FC, LS, CWLS, tells).
+3. When a message contains the trigger text, the plugin invites the **sender** of that message to your party using the game’s party invite API.
+
+For **tells**, the game provides the sender’s content ID and world, so invites work reliably. For **FC, LS, and CWLS**, the plugin uses the sender’s content ID when available (e.g. from the last message in CWLS), so cross-world invites work for CWLS and same-world for FC/LS.
+
+## Building
+
+1. Open `HSRTools.sln` in Visual Studio or use the command line.
+2. Build in **Release** (or use your dev plugin folder for testing):
+
+   ```bash
+   dotnet build HSRTools.sln -c Release
+   ```
+
+3. The SDK uses your XIVLauncher dev environment; the built DLL goes to your dev plugin folder.
+
+## Configuration
+
+- Open the plugin config from the Dalamud plugin list (right-click HSRTools → **Settings**).
+- Set the trigger text, enable/disable the plugin, choose channels, and set case sensitivity.
+- Settings are saved when you close the game or disable the plugin.
+
+## Requirements
+
+- [XIVLauncher](https://github.com/goatcorp/FFXIVQuickLauncher) with Dalamud
+- .NET (as required by your Dalamud version)
+
+## Installation
+
+- **From official Dalamud repo:** If this plugin is accepted, install via XIVLauncher → Dalamud Settings → Plugin Installer.
+- **Third-party / dev:** Add a custom plugin repo that points to a `pluginmaster.json` (see [Releasing](#releasing)), or download the latest release zip from [Releases](https://github.com/Knack117/HSRTools/releases) and extract into your Dalamud plugin folder.
+
+## Releasing
+
+1. Bump `Version` in `HSRTools/HSRTools.csproj` and update `CHANGELOG.md`.
+2. Build: `dotnet build HSRTools.sln -c Release`.
+3. Zip the contents of `HSRTools/bin/Release/HSRTools/` (DLL + `HSRTools.json`) as `HSRTools.zip`.
+4. Create a new GitHub release with tag `v1.0.0` (match version), attach `HSRTools.zip`.
+5. Update `pluginmaster.json`: set `AssemblyVersion`, `LastUpdate` (Unix timestamp), and `DownloadLinkInstall` / `DownloadLinkUpdate` to the release zip URL, e.g. `https://github.com/Knack117/HSRTools/releases/download/v1.0.0/HSRTools.zip`.
+6. To get on the official Dalamud repo: open a PR to [goatcorp/DalamudPlugins](https://github.com/goatcorp/DalamudPlugins) with your plugin and a `pluginmaster.json` entry (they host the zip; see their repo for the exact format).
+
+## License
+
+MIT. See [LICENSE](LICENSE). This plugin is not officially affiliated with Square Enix or the FFXIV project.