Compare commits

..

No commits in common. "master" and "v6.0" have entirely different histories.
master ... v6.0

9 changed files with 256 additions and 264 deletions

10
.gitignore vendored
View File

@ -1,6 +1,4 @@
/dist .vs/
/obj obj/
/bin dist/
/.idea *.user
/.vs
*.user

View File

@ -1,9 +1,25 @@
using Dalamud.Configuration; using Dalamud.Configuration;
using Dalamud.Plugin;
using System;
namespace FishNotify; namespace FishNotify
internal sealed class Configuration : IPluginConfiguration
{ {
public int Version { get; set; } = 0; internal class Configuration : IPluginConfiguration
public bool ChatAlerts { get; set; } = false; {
public int Version { get; set; } = 0;
public bool ChatAlerts { get; set; } = false;
[NonSerialized]
private DalamudPluginInterface pluginInterface = null!;
public void Initialize(DalamudPluginInterface pluginInterface)
{
this.pluginInterface = pluginInterface;
}
public void Save()
{
this.pluginInterface.SavePluginConfig(this);
}
}
} }

View File

@ -1,7 +1,10 @@
using Dalamud.Game.Network; using Dalamud.Data;
using Dalamud.Game.Gui;
using Dalamud.Game.Network;
using Dalamud.Game.Text.SeStringHandling; using Dalamud.Game.Text.SeStringHandling;
using Dalamud.Interface.Colors; using Dalamud.Interface.Colors;
using Dalamud.IoC; using Dalamud.IoC;
using Dalamud.Logging;
using Dalamud.Plugin; using Dalamud.Plugin;
using ImGuiNET; using ImGuiNET;
using Newtonsoft.Json; using Newtonsoft.Json;
@ -10,183 +13,197 @@ using System.Collections.Generic;
using System.Net.Http; using System.Net.Http;
using System.Runtime.InteropServices; using System.Runtime.InteropServices;
using System.Threading.Tasks; using System.Threading.Tasks;
using Dalamud.Plugin.Services;
namespace FishNotify; namespace FishNotify
public sealed class FishNotifyPlugin : IDalamudPlugin
{ {
[PluginService] public sealed class FishNotifyPlugin : IDalamudPlugin
private IDalamudPluginInterface PluginInterface { get; set; } = null!;
[PluginService]
private IGameNetwork Network { get; set; } = null!;
[PluginService]
private IChatGui Chat { get; set; } = null!;
[PluginService]
private IPluginLog PluginLog { get; set; } = null!;
private readonly Configuration _configuration;
private bool _settingsVisible;
private int _expectedOpCode = -1;
private uint _fishCount;
public FishNotifyPlugin()
{ {
_configuration = PluginInterface.GetPluginConfig() as Configuration ?? new Configuration(); public string Name => "FishNotify";
Network.NetworkMessage += OnNetworkMessage; [PluginService]
PluginInterface.UiBuilder.Draw += OnDrawUI; [RequiredVersion("1.0")]
PluginInterface.UiBuilder.OpenConfigUi += OnOpenConfigUi; private DalamudPluginInterface PluginInterface { get; set; } = null!;
var client = new HttpClient(); [PluginService]
client.GetStringAsync("https://raw.githubusercontent.com/karashiiro/FFXIVOpcodes/master/opcodes.min.json") private GameNetwork Network { get; set; } = null!;
.ContinueWith(ExtractOpCode);
}
public void Dispose() [PluginService]
{ public static ChatGui Chat { get; set; } = null!;
Network.NetworkMessage -= OnNetworkMessage;
PluginInterface.UiBuilder.Draw -= OnDrawUI;
PluginInterface.UiBuilder.OpenConfigUi -= OnOpenConfigUi;
}
private void ExtractOpCode(Task<string> task) private Configuration configuration;
{ private bool settingsVisible;
try private int expectedOpCode = -1;
private uint fishCount = 0;
public FishNotifyPlugin()
{ {
var regions = JsonConvert.DeserializeObject<List<OpcodeRegion>>(task.Result); configuration = PluginInterface.GetPluginConfig() as Configuration ?? new Configuration();
if (regions == null) configuration.Initialize(PluginInterface);
Network.NetworkMessage += OnNetworkMessage;
PluginInterface.UiBuilder.Draw += OnDrawUI;
PluginInterface.UiBuilder.OpenConfigUi += OnOpenConfigUi;
var client = new HttpClient();
client.GetStringAsync("https://raw.githubusercontent.com/karashiiro/FFXIVOpcodes/master/opcodes.min.json")
.ContinueWith(ExtractOpCode);
}
public void Dispose()
{
Network.NetworkMessage -= OnNetworkMessage;
PluginInterface.UiBuilder.Draw -= OnDrawUI;
PluginInterface.UiBuilder.OpenConfigUi -= OnOpenConfigUi;
}
private void ExtractOpCode(Task<string> task)
{
try
{
var regions = JsonConvert.DeserializeObject<List<OpcodeRegion>>(task.Result);
if (regions == null)
{
PluginLog.Warning("No regions found in opcode list");
return;
}
var region = regions.Find(r => r.Region == "Global");
if (region == null || region.Lists == null)
{
PluginLog.Warning("No global region found in opcode list");
return;
}
if (!region.Lists.TryGetValue("ServerZoneIpcType", out List<OpcodeList>? serverZoneIpcTypes) || serverZoneIpcTypes == null)
{
PluginLog.Warning("No ServerZoneIpcType in opcode list");
return;
}
var eventPlay = serverZoneIpcTypes.Find(opcode => opcode.Name == "EventPlay");
if (eventPlay == null)
{
PluginLog.Warning("No EventPlay opcode in ServerZoneIpcType");
return;
}
expectedOpCode = eventPlay.Opcode;
PluginLog.Debug($"Found EventPlay opcode {expectedOpCode:X4}");
}
catch (Exception e)
{
PluginLog.Error(e, "Could not download/extract opcodes: {}", e.Message);
}
}
private void OnNetworkMessage(IntPtr dataPtr, ushort opCode, uint sourceActorId, uint targetActorId, NetworkMessageDirection direction)
{
if (direction != NetworkMessageDirection.ZoneDown || opCode != expectedOpCode)
return;
var data = new byte[32];
Marshal.Copy(dataPtr, data, 0, data.Length);
int eventId = BitConverter.ToInt32(data, 8);
short scene = BitConverter.ToInt16(data, 12);
int param5 = BitConverter.ToInt32(data, 28);
// Fishing event?
if (eventId != 0x00150001)
return;
// Fish hooked?
if (scene != 5)
return;
switch (param5)
{
case 0x124:
// light tug (!)
++fishCount;
Sounds.PlaySound(Resources.Info);
SendChatAlert("light");
break;
case 0x125:
// medium tug (!!)
++fishCount;
Sounds.PlaySound(Resources.Alert);
SendChatAlert("medium");
break;
case 0x126:
// heavy tug (!!!)
++fishCount;
Sounds.PlaySound(Resources.Alarm);
SendChatAlert("heavy");
break;
default:
Sounds.Stop();
break;
}
}
private void SendChatAlert(string size)
{
if (!configuration.ChatAlerts)
{ {
PluginLog.Warning("No regions found in opcode list");
return; return;
} }
var region = regions.Find(r => r.Region == "Global"); SeString message = new SeStringBuilder()
if (region == null || region.Lists == null) .AddUiForeground(514)
{ .Append("[FishNotify]")
PluginLog.Warning("No global region found in opcode list"); .AddUiForegroundOff()
.Append($" You hook a fish with a ")
.AddUiForeground(514)
.Append(size)
.AddUiForegroundOff()
.Append(" bite.")
.Build();
Chat.Print(message);
}
private void OnDrawUI()
{
if (!settingsVisible)
return; return;
}
if (!region.Lists.TryGetValue("ServerZoneIpcType", out List<OpcodeList>? serverZoneIpcTypes) || serverZoneIpcTypes == null) if (ImGui.Begin("FishNotify", ref this.settingsVisible, ImGuiWindowFlags.AlwaysAutoResize))
{ {
PluginLog.Warning("No ServerZoneIpcType in opcode list"); var chatAlerts = configuration.ChatAlerts;
return; if (ImGui.Checkbox("Show chat message on hooking a fish", ref chatAlerts))
{
configuration.ChatAlerts = chatAlerts;
configuration.Save();
}
if (expectedOpCode > -1)
ImGui.TextColored(ImGuiColors.HealerGreen, $"Status: {(fishCount == 0 ? "Unknown (not triggered yet)" : $"OK ({fishCount} fish hooked)")}, opcode = {expectedOpCode:X}");
else
ImGui.TextColored(ImGuiColors.DalamudRed, "Status: No opcode :(");
} }
ImGui.End();
var eventPlay = serverZoneIpcTypes.Find(opcode => opcode.Name == "EventPlay");
if (eventPlay == null)
{
PluginLog.Warning("No EventPlay opcode in ServerZoneIpcType");
return;
}
_expectedOpCode = eventPlay.Opcode;
PluginLog.Debug($"Found EventPlay opcode {_expectedOpCode:X4}");
} }
catch (Exception e)
private void OnOpenConfigUi()
{ {
PluginLog.Error(e, "Could not download/extract opcodes: {}", e.Message); settingsVisible = !settingsVisible;
} }
} }
private void OnNetworkMessage(IntPtr dataPtr, ushort opCode, uint sourceActorId, uint targetActorId, NetworkMessageDirection direction) public class OpcodeRegion
{ {
if (direction != NetworkMessageDirection.ZoneDown || opCode != _expectedOpCode) public string? Version { get; set; }
return; public string? Region { get; set; }
public Dictionary<string, List<OpcodeList>>? Lists { get; set; }
var data = new byte[32];
Marshal.Copy(dataPtr, data, 0, data.Length);
int eventId = BitConverter.ToInt32(data, 8);
short scene = BitConverter.ToInt16(data, 12);
int param5 = BitConverter.ToInt32(data, 28);
// Fishing event?
if (eventId != 0x00150001)
return;
// Fish hooked?
if (scene != 5)
return;
switch (param5)
{
case 0x124:
// light tug (!)
++_fishCount;
Sounds.PlaySound(Resources.Info);
SendChatAlert("light");
break;
case 0x125:
// medium tug (!!)
++_fishCount;
Sounds.PlaySound(Resources.Alert);
SendChatAlert("medium");
break;
case 0x126:
// heavy tug (!!!)
++_fishCount;
Sounds.PlaySound(Resources.Alarm);
SendChatAlert("heavy");
break;
default:
Sounds.Stop();
break;
}
} }
private void SendChatAlert(string size) public class OpcodeList
{ {
if (!_configuration.ChatAlerts) public string? Name { get; set; }
{ public ushort Opcode { get; set; }
return;
}
SeString message = new SeStringBuilder()
.AddUiForeground(514)
.Append("[FishNotify]")
.AddUiForegroundOff()
.Append(" You hook a fish with a ")
.AddUiForeground(514)
.Append(size)
.AddUiForegroundOff()
.Append(" bite.")
.Build();
Chat.Print(message);
}
private void OnDrawUI()
{
if (!_settingsVisible)
return;
if (ImGui.Begin("FishNotify", ref _settingsVisible, ImGuiWindowFlags.AlwaysAutoResize))
{
var chatAlerts = _configuration.ChatAlerts;
if (ImGui.Checkbox("Show chat message on hooking a fish", ref chatAlerts))
{
_configuration.ChatAlerts = chatAlerts;
PluginInterface.SavePluginConfig(_configuration);
}
if (_expectedOpCode > -1)
ImGui.TextColored(ImGuiColors.HealerGreen, $"Status: {(_fishCount == 0 ? "Unknown (not triggered yet)" : $"OK ({_fishCount} fish hooked)")}, opcode = {_expectedOpCode:X}");
else
ImGui.TextColored(ImGuiColors.DalamudRed, "Status: No opcode :(");
}
ImGui.End();
}
private void OnOpenConfigUi()
{
_settingsVisible = !_settingsVisible;
} }
} }

View File

@ -1,17 +1,72 @@
<Project Sdk="Dalamud.NET.Sdk/9.0.2"> <?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<Version>7.0</Version> <Authors></Authors>
<Company></Company>
<Version>5.0</Version>
<Description>Plays a sound effect when a fish bites</Description>
<Copyright></Copyright>
<PackageProjectUrl>https://github.com/carvelli/Fish-Notify</PackageProjectUrl>
<Configurations>Release</Configurations>
</PropertyGroup>
<PropertyGroup>
<TargetFramework>net7.0-windows</TargetFramework>
<Platforms>x64</Platforms>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks> <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<ProduceReferenceAssembly>false</ProduceReferenceAssembly>
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<OutputPath>dist</OutputPath> <OutputPath>dist</OutputPath>
</PropertyGroup> </PropertyGroup>
<ItemGroup>
<Content Include="FishNotify.json">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
</ItemGroup>
<PropertyGroup>
<DalamudLibPath>$(appdata)\XIVLauncher\addon\Hooks\dev\</DalamudLibPath>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'"> <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<DebugType>none</DebugType> <DebugType>none</DebugType>
<DebugSymbols>false</DebugSymbols> <DebugSymbols>false</DebugSymbols>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="System.Windows.Extensions" Version="8.0.0" /> <PackageReference Include="DalamudPackager" Version="2.1.10" />
<PackageReference Include="System.Windows.Extensions" Version="7.0.0" />
<Reference Include="FFXIVClientStructs">
<HintPath>$(DalamudLibPath)FFXIVClientStructs.dll</HintPath>
<Private>false</Private>
</Reference>
<Reference Include="Newtonsoft.Json">
<HintPath>$(DalamudLibPath)Newtonsoft.Json.dll</HintPath>
<Private>false</Private>
</Reference>
<Reference Include="Dalamud">
<HintPath>$(DalamudLibPath)Dalamud.dll</HintPath>
<Private>false</Private>
</Reference>
<Reference Include="ImGui.NET">
<HintPath>$(DalamudLibPath)ImGui.NET.dll</HintPath>
<Private>false</Private>
</Reference>
<Reference Include="ImGuiScene">
<HintPath>$(DalamudLibPath)ImGuiScene.dll</HintPath>
<Private>false</Private>
</Reference>
<Reference Include="Lumina">
<HintPath>$(DalamudLibPath)Lumina.dll</HintPath>
<Private>false</Private>
</Reference>
<Reference Include="Lumina.Excel">
<HintPath>$(DalamudLibPath)Lumina.Excel.dll</HintPath>
<Private>false</Private>
</Reference>
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@ -8,5 +8,5 @@
"fishing" "fishing"
], ],
"RepoUrl": "https://git.carvel.li/liza/FishNotify", "RepoUrl": "https://git.carvel.li/liza/FishNotify",
"IconUrl": "https://plugins.carvel.li/icons/FishNotify.png" "IconUrl": "https://git.carvel.li/liza/plugin-repo/raw/branch/master/dist/FishNotify.png"
} }

View File

@ -1,7 +0,0 @@
namespace FishNotify;
public class OpcodeList
{
public string? Name { get; set; }
public ushort Opcode { get; set; }
}

View File

@ -1,10 +0,0 @@
using System.Collections.Generic;
namespace FishNotify;
public class OpcodeRegion
{
public string? Version { get; set; }
public string? Region { get; set; }
public Dictionary<string, List<OpcodeList>>? Lists { get; set; }
}

View File

@ -5,4 +5,4 @@ watching YouTube during fishing.
## Installation ## Installation
[Installation Instructions](https://git.carvel.li/liza/plugin-repo/src/branch/master/README.md). [Installation Instructions](https://github.com/carvelli/Dalamud-Plugins#installation).

View File

@ -1,77 +0,0 @@
{
"version": 1,
"dependencies": {
"net8.0-windows7.0": {
"DalamudPackager": {
"type": "Direct",
"requested": "[2.1.13, )",
"resolved": "2.1.13",
"contentHash": "rMN1omGe8536f4xLMvx9NwfvpAc9YFFfeXJ1t4P4PE6Gu8WCIoFliR1sh07hM+bfODmesk/dvMbji7vNI+B/pQ=="
},
"DotNet.ReproducibleBuilds": {
"type": "Direct",
"requested": "[1.1.1, )",
"resolved": "1.1.1",
"contentHash": "+H2t/t34h6mhEoUvHi8yGXyuZ2GjSovcGYehJrS2MDm2XgmPfZL2Sdxg+uL2lKgZ4M6tTwKHIlxOob2bgh0NRQ==",
"dependencies": {
"Microsoft.SourceLink.AzureRepos.Git": "1.1.1",
"Microsoft.SourceLink.Bitbucket.Git": "1.1.1",
"Microsoft.SourceLink.GitHub": "1.1.1",
"Microsoft.SourceLink.GitLab": "1.1.1"
}
},
"System.Windows.Extensions": {
"type": "Direct",
"requested": "[8.0.0, )",
"resolved": "8.0.0",
"contentHash": "Obg3a90MkOw9mYKxrardLpY2u0axDMrSmy4JCdq2cYbelM2cUwmUir5Bomvd1yxmPL9h5LVHU1tuKBZpUjfASg=="
},
"Microsoft.Build.Tasks.Git": {
"type": "Transitive",
"resolved": "1.1.1",
"contentHash": "AT3HlgTjsqHnWpBHSNeR0KxbLZD7bztlZVj7I8vgeYG9SYqbeFGh0TM/KVtC6fg53nrWHl3VfZFvb5BiQFcY6Q=="
},
"Microsoft.SourceLink.AzureRepos.Git": {
"type": "Transitive",
"resolved": "1.1.1",
"contentHash": "qB5urvw9LO2bG3eVAkuL+2ughxz2rR7aYgm2iyrB8Rlk9cp2ndvGRCvehk3rNIhRuNtQaeKwctOl1KvWiklv5w==",
"dependencies": {
"Microsoft.Build.Tasks.Git": "1.1.1",
"Microsoft.SourceLink.Common": "1.1.1"
}
},
"Microsoft.SourceLink.Bitbucket.Git": {
"type": "Transitive",
"resolved": "1.1.1",
"contentHash": "cDzxXwlyWpLWaH0em4Idj0H3AmVo3L/6xRXKssYemx+7W52iNskj/SQ4FOmfCb8YQt39otTDNMveCZzYtMoucQ==",
"dependencies": {
"Microsoft.Build.Tasks.Git": "1.1.1",
"Microsoft.SourceLink.Common": "1.1.1"
}
},
"Microsoft.SourceLink.Common": {
"type": "Transitive",
"resolved": "1.1.1",
"contentHash": "WMcGpWKrmJmzrNeuaEb23bEMnbtR/vLmvZtkAP5qWu7vQsY59GqfRJd65sFpBszbd2k/bQ8cs8eWawQKAabkVg=="
},
"Microsoft.SourceLink.GitHub": {
"type": "Transitive",
"resolved": "1.1.1",
"contentHash": "IaJGnOv/M7UQjRJks7B6p7pbPnOwisYGOIzqCz5ilGFTApZ3ktOR+6zJ12ZRPInulBmdAf1SrGdDG2MU8g6XTw==",
"dependencies": {
"Microsoft.Build.Tasks.Git": "1.1.1",
"Microsoft.SourceLink.Common": "1.1.1"
}
},
"Microsoft.SourceLink.GitLab": {
"type": "Transitive",
"resolved": "1.1.1",
"contentHash": "tvsg47DDLqqedlPeYVE2lmiTpND8F0hkrealQ5hYltSmvruy/Gr5nHAKSsjyw5L3NeM/HLMI5ORv7on/M4qyZw==",
"dependencies": {
"Microsoft.Build.Tasks.Git": "1.1.1",
"Microsoft.SourceLink.Common": "1.1.1"
}
}
}
}
}