commit 38d7991097ae75faa4be6ce3762e3d299d0921a1
Author: Kacie <90719658+kaciexx@users.noreply.github.com>
Date: Tue Jan 24 22:50:56 2023 +0100
Initial commit
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..1e47248
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,138 @@
+root = true
+# top-most EditorConfig file
+
+[*]
+charset = utf-8
+
+end_of_line = lf
+insert_final_newline = true
+
+# 4 space indentation
+indent_style = space
+indent_size = 4
+
+# disable redundant style warnings
+
+# Microsoft .NET properties
+csharp_indent_braces = false
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = false
+csharp_new_line_before_open_brace = all
+csharp_preferred_modifier_order = public, private, protected, internal, new, abstract, virtual, sealed, override, static, readonly, extern, unsafe, volatile, async:suggestion
+csharp_style_var_elsewhere = true:suggestion
+csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_when_type_is_apparent = true:suggestion
+dotnet_code_quality_unused_parameters = non_public
+dotnet_naming_rule.event_rule.severity = warning
+dotnet_naming_rule.event_rule.style = on_upper_camel_case_style
+dotnet_naming_rule.event_rule.symbols = event_symbols
+dotnet_naming_rule.private_constants_rule.severity = warning
+dotnet_naming_rule.private_constants_rule.style = upper_camel_case_style
+dotnet_naming_rule.private_constants_rule.symbols = private_constants_symbols
+dotnet_naming_rule.private_instance_fields_rule.severity = warning
+dotnet_naming_rule.private_instance_fields_rule.style = lower_camel_case_style
+dotnet_naming_rule.private_instance_fields_rule.symbols = private_instance_fields_symbols
+dotnet_naming_rule.private_static_fields_rule.severity = warning
+dotnet_naming_rule.private_static_fields_rule.style = upper_camel_case_style
+dotnet_naming_rule.private_static_fields_rule.symbols = private_static_fields_symbols
+dotnet_naming_rule.private_static_readonly_rule.severity = warning
+dotnet_naming_rule.private_static_readonly_rule.style = upper_camel_case_style
+dotnet_naming_rule.private_static_readonly_rule.symbols = private_static_readonly_symbols
+dotnet_naming_style.lower_camel_case_style.capitalization = camel_case
+dotnet_naming_style.on_upper_camel_case_style.capitalization = pascal_case
+dotnet_naming_style.on_upper_camel_case_style.required_prefix = On
+dotnet_naming_style.upper_camel_case_style.capitalization = pascal_case
+dotnet_naming_symbols.event_symbols.applicable_accessibilities = *
+dotnet_naming_symbols.event_symbols.applicable_kinds = event
+dotnet_naming_symbols.private_constants_symbols.applicable_accessibilities = private
+dotnet_naming_symbols.private_constants_symbols.applicable_kinds = field
+dotnet_naming_symbols.private_constants_symbols.required_modifiers = const
+dotnet_naming_symbols.private_instance_fields_symbols.applicable_accessibilities = private
+dotnet_naming_symbols.private_instance_fields_symbols.applicable_kinds = field
+dotnet_naming_symbols.private_static_fields_symbols.applicable_accessibilities = private
+dotnet_naming_symbols.private_static_fields_symbols.applicable_kinds = field
+dotnet_naming_symbols.private_static_fields_symbols.required_modifiers = static
+dotnet_naming_symbols.private_static_readonly_symbols.applicable_accessibilities = private
+dotnet_naming_symbols.private_static_readonly_symbols.applicable_kinds = field
+dotnet_naming_symbols.private_static_readonly_symbols.required_modifiers = static,readonly
+dotnet_style_parentheses_in_arithmetic_binary_operators =always_for_clarity:suggestion
+dotnet_style_parentheses_in_other_binary_operators =always_for_clarity:suggestion
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
+dotnet_style_parentheses_in_other_operators=always_for_clarity:silent
+dotnet_style_object_initializer = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_comma = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_comma = true
+csharp_space_after_cast = false
+csharp_space_around_binary_operators = before_and_after
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = none
+csharp_space_between_square_brackets = false
+
+# ReSharper properties
+resharper_align_linq_query = true
+resharper_align_multiline_argument = true
+resharper_align_multiline_calls_chain = true
+resharper_align_multiline_expression = true
+resharper_align_multiline_extends_list = true
+resharper_align_multiline_for_stmt = true
+resharper_align_multline_type_parameter_constrains = true
+resharper_align_multline_type_parameter_list = true
+resharper_apply_on_completion = true
+resharper_auto_property_can_be_made_get_only_global_highlighting = none
+resharper_auto_property_can_be_made_get_only_local_highlighting = none
+resharper_autodetect_indent_settings = true
+resharper_braces_for_ifelse = required_for_multiline
+resharper_can_use_global_alias = false
+resharper_csharp_align_multiline_parameter = true
+resharper_csharp_align_multiple_declaration = true
+resharper_csharp_empty_block_style = together_same_line
+resharper_csharp_int_align_comments = true
+resharper_csharp_new_line_before_while = true
+resharper_csharp_wrap_after_declaration_lpar = true
+resharper_enforce_line_ending_style = true
+resharper_member_can_be_private_global_highlighting = none
+resharper_member_can_be_private_local_highlighting = none
+resharper_new_line_before_finally = false
+resharper_place_accessorholder_attribute_on_same_line = false
+resharper_place_field_attribute_on_same_line = false
+resharper_show_autodetect_configure_formatting_tip = false
+resharper_use_indent_from_vs = false
+
+# ReSharper inspection severities
+resharper_arrange_missing_parentheses_highlighting = hint
+resharper_arrange_redundant_parentheses_highlighting = hint
+resharper_arrange_this_qualifier_highlighting = none
+resharper_arrange_type_member_modifiers_highlighting = hint
+resharper_arrange_type_modifiers_highlighting = hint
+resharper_built_in_type_reference_style_for_member_access_highlighting = hint
+resharper_built_in_type_reference_style_highlighting = none
+resharper_foreach_can_be_converted_to_query_using_another_get_enumerator_highlighting = none
+resharper_foreach_can_be_partly_converted_to_query_using_another_get_enumerator_highlighting = none
+resharper_invert_if_highlighting = none
+resharper_loop_can_be_converted_to_query_highlighting = none
+resharper_method_has_async_overload_highlighting = none
+resharper_private_field_can_be_converted_to_local_variable_highlighting = none
+resharper_redundant_base_qualifier_highlighting = none
+resharper_suggest_var_or_type_built_in_types_highlighting = hint
+resharper_suggest_var_or_type_elsewhere_highlighting = hint
+resharper_suggest_var_or_type_simple_types_highlighting = hint
+resharper_unused_auto_property_accessor_global_highlighting = none
+csharp_style_deconstructed_variable_declaration=true:silent
+
+[*.{appxmanifest,asax,ascx,aspx,axaml,axml,build,c,c++,cc,cginc,compute,config,cp,cpp,cs,cshtml,csproj,css,cu,cuh,cxx,dbml,discomap,dtd,h,hh,hlsl,hlsli,hlslinc,hpp,htm,html,hxx,inc,inl,ino,ipp,js,json,jsproj,jsx,lsproj,master,mpp,mq4,mq5,mqh,njsproj,nuspec,paml,proj,props,proto,razor,resjson,resw,resx,skin,StyleCop,targets,tasks,tpp,ts,tsx,usf,ush,vb,vbproj,xaml,xamlx,xml,xoml,xsd}]
+indent_style = space
+indent_size = 4
+tab_width = 4
+dotnet_style_parentheses_in_other_operators=always_for_clarity:silent
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7990fe7
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+.vs/
+obj/
+bin/
+*.user
\ No newline at end of file
diff --git a/Data/logo.png b/Data/logo.png
new file mode 100644
index 0000000..9fad603
Binary files /dev/null and b/Data/logo.png differ
diff --git a/Data/logo_128.png b/Data/logo_128.png
new file mode 100644
index 0000000..a6fb267
Binary files /dev/null and b/Data/logo_128.png differ
diff --git a/Docs/.DALAMUD_UPDATES.md.swp b/Docs/.DALAMUD_UPDATES.md.swp
new file mode 100644
index 0000000..48c7443
Binary files /dev/null and b/Docs/.DALAMUD_UPDATES.md.swp differ
diff --git a/Docs/BUILD.md b/Docs/BUILD.md
new file mode 100644
index 0000000..fe7ecc4
--- /dev/null
+++ b/Docs/BUILD.md
@@ -0,0 +1,15 @@
+# How to build
+
+Simply use: Microsoft Visual Studio Community 2022 (64-bit)
+Current Version on our side is: 17.0.2
+
+Don't forget to install the Nuggets:
+- Buttplug (as of 14.01.2022 version is 2.0.6)
+- DalamudPackager (as of 14.01.2022 version is 2.1.5)
+- Lumina (as of 14.01.2022 version is 3.5.1)
+- Lumina.Excel (as of 14.01.2022 version is 6.0.2)
+
+# Package for plugin
+Simply change the mode from Debug to Release. Ignore the error reported for UIDev project that is missing the manifest.
+
+The build will be in the project under: FFXIV\_Vibe\_Plugin/bin/x64/Release
diff --git a/Docs/RELEASE.md b/Docs/RELEASE.md
new file mode 100644
index 0000000..465d810
--- /dev/null
+++ b/Docs/RELEASE.md
@@ -0,0 +1,15 @@
+# Internal release process reminder
+1. Bump the C# assembly project version (double click on FFXIV\_Vibe\_Plugin in Visual Studio).
+2. Build in release mode (ignore the error saying that the manifest file could not be found)
+3. Go to the FFXIV\_Vibe\_Plugin\bin\x64\Release folder and **again** in FFXIV\_Vibe\_Plugin folder.
+4. Rename the ZIP to the corresponding version (eg: FFXIV\_Vibe\_Plugin\_v1.4.0.0.zip)
+5. Update the repo.json version, timestamp, downloadCount and download links.
+6. Commit your changes and push.
+7. Tag the project version (eg: `git tag v1.4.0.0`) and push the tag.
+8. Create a release on github, upload the zip and publish
+9. Remove the FFXIV\_Vibe\_Plugin in devPlugins/FFXIV\_Vibe\_Plugin
+
+
+# Conventions
+
+Version: 1.7.0.0 refers to Dalamud API 7
diff --git a/Docs/RESOURCES.md b/Docs/RESOURCES.md
new file mode 100644
index 0000000..7b48233
--- /dev/null
+++ b/Docs/RESOURCES.md
@@ -0,0 +1,13 @@
+# Some resources
+
+- https://karashiiro.moe/xiv-resources/
+- Sapphire server: https://github.com/SapphireServer/Sapphire/blob/master/src/common/Network/PacketDef/Zone/ClientZoneDef.h#L72
+- Machine MessageHeader: https://github.com/ravahn/machina/blob/master/Machina.FFXIV/Headers/Server_MessageHeader.cs
+- Some valid? opCodes: https://github.com/karashiiro/FFXIVOpcodes/blob/master/opcodes.json
+- https://xiv.dev/community-projects
+- Example of hook: https://github.com/Caraxi/AdventurerInNeed/blob/master/AdventurerInNeed.cs#L112
+- Data struct inspiration: https://gitlab.com/kaminariss/nextui-plugin/-/tree/master/NextUIPlugin/NetworkStructures/Server
+- Lumina: https://lumina.xiv.dev/docs/guides/basic-usage.html
+- Hook ActionEffect: https://github.com/lmcintyre/DamageInfoPlugin/blob/main/DamageInfoPlugin/DamageInfoPlugin.cs
+- https://github.com/aers/FFXIVClientStructs/tree/main/FFXIVClientStructs/FFXIV/
+- https://github.com/digital-pet/AetherSenseRedux/blob/master/AetherSenseRedux/Device.cs
\ No newline at end of file
diff --git a/Docs/TODO.md b/Docs/TODO.md
new file mode 100644
index 0000000..495d8e1
--- /dev/null
+++ b/Docs/TODO.md
@@ -0,0 +1,16 @@
+# TODO & IDEAS
+
+## IDEA 1
+Make triggers not trigger and overwrite each others if they are of the same priority? But also make triggers be able to overwrite each other if one trigger has a higher priority over the other?
+
+For example:
+With a HPChange trigger that triggers when HP Min is at 10% and HP Max is at 30%. Any time HP changes between 10% and 30% (ex. enemy hitting, or poison tick), the trigger will retrigger, causing the vibration pattern to restart. It'd be nice to allow the pattern to finish before sending another trigger signal 🙂
+
+## IDEA 1 - Kaciexx solution
+if newTrigger.Priority == currentTrigger.Priority and
+ currentTrigger.CantBeOverwritten and
+ currentTrigger.HasNotEnded
+ ignore newTrigger
+
+## To be discussed
+- Feature to export trigger (without TriggerDevice). Export feature ?
diff --git a/Docs/screenshot.png b/Docs/screenshot.png
new file mode 100644
index 0000000..fd246a2
Binary files /dev/null and b/Docs/screenshot.png differ
diff --git a/FFXIV_Vibe_Plugin.sln b/FFXIV_Vibe_Plugin.sln
new file mode 100644
index 0000000..0b874c1
--- /dev/null
+++ b/FFXIV_Vibe_Plugin.sln
@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.3.32929.385
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FFXIV_Vibe_Plugin", "FFXIV_Vibe_Plugin\FFXIV_Vibe_Plugin.csproj", "{13C812E9-0D42-4B95-8646-40EEBF30636F}"
+EndProject
+Global
+ GlobalSection(SolutionConfigurationPlatforms) = preSolution
+ Debug|x64 = Debug|x64
+ Release|x64 = Release|x64
+ EndGlobalSection
+ GlobalSection(ProjectConfigurationPlatforms) = postSolution
+ {13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|x64.ActiveCfg = Debug|x64
+ {13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|x64.Build.0 = Debug|x64
+ {13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|x64.ActiveCfg = Release|x64
+ {13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|x64.Build.0 = Release|x64
+ EndGlobalSection
+ GlobalSection(SolutionProperties) = preSolution
+ HideSolutionNode = FALSE
+ EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {B17E85B1-5F60-4440-9F9A-3DDE877E8CDF}
+ EndGlobalSection
+EndGlobal
diff --git a/FFXIV_Vibe_Plugin/Configuration.cs b/FFXIV_Vibe_Plugin/Configuration.cs
new file mode 100644
index 0000000..432ed34
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/Configuration.cs
@@ -0,0 +1,28 @@
+using Dalamud.Configuration;
+using Dalamud.Plugin;
+using System;
+
+namespace FFXIV_Plugin_Vibe
+{
+ [Serializable]
+ public class Configuration : IPluginConfiguration
+ {
+ public int Version { get; set; } = 0;
+
+ public bool SomePropertyToBeSavedAndWithADefault { get; set; } = true;
+
+ // the below exist just to make saving less cumbersome
+ [NonSerialized]
+ private DalamudPluginInterface? PluginInterface;
+
+ public void Initialize(DalamudPluginInterface pluginInterface)
+ {
+ this.PluginInterface = pluginInterface;
+ }
+
+ public void Save()
+ {
+ this.PluginInterface!.SavePluginConfig(this);
+ }
+ }
+}
diff --git a/FFXIV_Vibe_Plugin/FFXIV_Vibe_Plugin.csproj b/FFXIV_Vibe_Plugin/FFXIV_Vibe_Plugin.csproj
new file mode 100644
index 0000000..cea1413
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/FFXIV_Vibe_Plugin.csproj
@@ -0,0 +1,71 @@
+
+
+
+
+
+ 0.0.0.1
+ A sample plugin.
+
+ https://github.com/goatcorp/SamplePlugin
+
+
+
+ net7.0-windows
+ x64
+ enable
+ latest
+ true
+ false
+ false
+ true
+
+
+
+
+ PreserveNewest
+ false
+
+
+
+
+ $(appdata)\XIVLauncher\addon\Hooks\dev\
+ true
+
+
+
+ $(DALAMUD_HOME)/
+
+
+
+
+
+ $(DalamudLibPath)FFXIVClientStructs.dll
+ false
+
+
+ $(DalamudLibPath)Newtonsoft.Json.dll
+ false
+
+
+ $(DalamudLibPath)Dalamud.dll
+ false
+
+
+ $(DalamudLibPath)ImGui.NET.dll
+ false
+
+
+ $(DalamudLibPath)ImGuiScene.dll
+ false
+
+
+ $(DalamudLibPath)Lumina.dll
+ false
+
+
+ $(DalamudLibPath)Lumina.Excel.dll
+ false
+
+
+
+
diff --git a/FFXIV_Vibe_Plugin/FFXIV_Vibe_Plugin.json b/FFXIV_Vibe_Plugin/FFXIV_Vibe_Plugin.json
new file mode 100644
index 0000000..89ec8e6
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/FFXIV_Vibe_Plugin.json
@@ -0,0 +1,14 @@
+{
+ "Author": "Kaciexx",
+ "Name": "FFXIV Vibe Plugin",
+ "Punchline": "Vibe controllers or toys",
+ "Description": "Plugin that let you vibe your controller or toys",
+ "RepoUrl": "https://github.com/kaciexx/FFXIV_Vibe_Plugin",
+ "InternalName": "FFXIV_Vibe_Plugin",
+ "ApplicableVersion": "any",
+ "Tags": [
+ "vibe",
+ "vibration",
+ "wave"
+ ]
+}
diff --git a/FFXIV_Vibe_Plugin/Plugin.cs b/FFXIV_Vibe_Plugin/Plugin.cs
new file mode 100644
index 0000000..db8a82a
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/Plugin.cs
@@ -0,0 +1,69 @@
+using Dalamud.Game.Command;
+using Dalamud.IoC;
+using Dalamud.Plugin;
+using System.IO;
+using System.Reflection;
+using Dalamud.Interface.Windowing;
+using FFXIV_Plugin_Vibe.Windows;
+
+namespace FFXIV_Plugin_Vibe
+{
+ public sealed class Plugin : IDalamudPlugin
+ {
+ public string Name => "Sample Plugin";
+ private const string CommandName = "/pmycommand";
+
+ private DalamudPluginInterface PluginInterface { get; init; }
+ private CommandManager CommandManager { get; init; }
+ public Configuration Configuration { get; init; }
+ public WindowSystem WindowSystem = new("SamplePlugin");
+
+ public Plugin(
+ [RequiredVersion("1.0")] DalamudPluginInterface pluginInterface,
+ [RequiredVersion("1.0")] CommandManager commandManager)
+ {
+ this.PluginInterface = pluginInterface;
+ this.CommandManager = commandManager;
+
+ this.Configuration = this.PluginInterface.GetPluginConfig() as Configuration ?? new Configuration();
+ this.Configuration.Initialize(this.PluginInterface);
+
+ // you might normally want to embed resources and load them from the manifest stream
+ var imagePath = Path.Combine(PluginInterface.AssemblyLocation.Directory?.FullName!, "goat.png");
+ var goatImage = this.PluginInterface.UiBuilder.LoadImage(imagePath);
+
+ WindowSystem.AddWindow(new ConfigWindow(this));
+ WindowSystem.AddWindow(new MainWindow(this, goatImage));
+
+ this.CommandManager.AddHandler(CommandName, new CommandInfo(OnCommand)
+ {
+ HelpMessage = "A useful message to display in /xlhelp"
+ });
+
+ this.PluginInterface.UiBuilder.Draw += DrawUI;
+ this.PluginInterface.UiBuilder.OpenConfigUi += DrawConfigUI;
+ }
+
+ public void Dispose()
+ {
+ this.WindowSystem.RemoveAllWindows();
+ this.CommandManager.RemoveHandler(CommandName);
+ }
+
+ private void OnCommand(string command, string args)
+ {
+ // in response to the slash command, just display our main ui
+ WindowSystem.GetWindow("My Amazing Window").IsOpen = true;
+ }
+
+ private void DrawUI()
+ {
+ this.WindowSystem.Draw();
+ }
+
+ public void DrawConfigUI()
+ {
+ WindowSystem.GetWindow("A Wonderful Configuration Window").IsOpen = true;
+ }
+ }
+}
diff --git a/FFXIV_Vibe_Plugin/Windows/ConfigWindow.cs b/FFXIV_Vibe_Plugin/Windows/ConfigWindow.cs
new file mode 100644
index 0000000..22b328c
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/Windows/ConfigWindow.cs
@@ -0,0 +1,36 @@
+using System;
+using System.Numerics;
+using Dalamud.Interface.Windowing;
+using ImGuiNET;
+
+namespace FFXIV_Plugin_Vibe.Windows;
+
+public class ConfigWindow : Window, IDisposable
+{
+ private Configuration Configuration;
+
+ public ConfigWindow(Plugin plugin) : base(
+ "A Wonderful Configuration Window",
+ ImGuiWindowFlags.NoResize | ImGuiWindowFlags.NoCollapse | ImGuiWindowFlags.NoScrollbar |
+ ImGuiWindowFlags.NoScrollWithMouse)
+ {
+ this.Size = new Vector2(232, 75);
+ this.SizeCondition = ImGuiCond.Always;
+
+ this.Configuration = plugin.Configuration;
+ }
+
+ public void Dispose() { }
+
+ public override void Draw()
+ {
+ // can't ref a property, so use a local copy
+ var configValue = this.Configuration.SomePropertyToBeSavedAndWithADefault;
+ if (ImGui.Checkbox("Random Config Bool", ref configValue))
+ {
+ this.Configuration.SomePropertyToBeSavedAndWithADefault = configValue;
+ // can save immediately on change, if you don't want to provide a "Save and Close" button
+ this.Configuration.Save();
+ }
+ }
+}
diff --git a/FFXIV_Vibe_Plugin/Windows/MainWindow.cs b/FFXIV_Vibe_Plugin/Windows/MainWindow.cs
new file mode 100644
index 0000000..fe7fc40
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/Windows/MainWindow.cs
@@ -0,0 +1,48 @@
+using System;
+using System.Numerics;
+using Dalamud.Interface.Windowing;
+using ImGuiNET;
+using ImGuiScene;
+
+namespace FFXIV_Plugin_Vibe.Windows;
+
+public class MainWindow : Window, IDisposable
+{
+ private TextureWrap GoatImage;
+ private Plugin Plugin;
+
+ public MainWindow(Plugin plugin, TextureWrap goatImage) : base(
+ "My Amazing Window", ImGuiWindowFlags.NoScrollbar | ImGuiWindowFlags.NoScrollWithMouse)
+ {
+ this.SizeConstraints = new WindowSizeConstraints
+ {
+ MinimumSize = new Vector2(375, 330),
+ MaximumSize = new Vector2(float.MaxValue, float.MaxValue)
+ };
+
+ this.GoatImage = goatImage;
+ this.Plugin = plugin;
+ }
+
+ public void Dispose()
+ {
+ this.GoatImage.Dispose();
+ }
+
+ public override void Draw()
+ {
+ ImGui.Text($"The random config bool is {this.Plugin.Configuration.SomePropertyToBeSavedAndWithADefault}");
+
+ if (ImGui.Button("Show Settings"))
+ {
+ this.Plugin.DrawConfigUI();
+ }
+
+ ImGui.Spacing();
+
+ ImGui.Text("Have a goat:");
+ ImGui.Indent(55);
+ ImGui.Image(this.GoatImage.ImGuiHandle, new Vector2(this.GoatImage.Width, this.GoatImage.Height));
+ ImGui.Unindent(55);
+ }
+}
diff --git a/FFXIV_Vibe_Plugin/packages.lock.json b/FFXIV_Vibe_Plugin/packages.lock.json
new file mode 100644
index 0000000..2426061
--- /dev/null
+++ b/FFXIV_Vibe_Plugin/packages.lock.json
@@ -0,0 +1,13 @@
+{
+ "version": 1,
+ "dependencies": {
+ "net7.0-windows7.0": {
+ "DalamudPackager": {
+ "type": "Direct",
+ "requested": "[2.1.10, )",
+ "resolved": "2.1.10",
+ "contentHash": "S6NrvvOnLgT4GDdgwuKVJjbFo+8ZEj+JsEYk9ojjOR/MMfv1dIFpT8aRJQfI24rtDcw1uF+GnSSMN4WW1yt7fw=="
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..dfa461a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4e18bf3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,136 @@
+# FFXIV Vibe Plugin
+
+
+
+
+
+
+
+A plugin for FFXIV that will let you vibe your controller or toys.
+
+## Features
+- Easy UI interface.
+- Connect your device (manually or automatically).
+- Trigger some pattern from chat message.
+ - Custom chat selection.
+ - Custom allowed characters.
+- Trigger some pattern from spells.
+ - Custom spell name.
+ - Custom spell type (damage, heal...).
+ - Custom spell direction (outgoing, incoming, self).
+ - Min and/or max dmg/heal values.
+- Multiple devices per custom trigger.
+- UI to search through your triggers.
+- Delay start and stop patterns.
+- Custom device and motors.
+- Using RegExp for chat messages and spell names.
+- Define global threshold or threshold per motor.
+- Displaying battery life of devices.
+- Custom patterns per motor (save, with easy import, export).
+- Vibe or trigger a pattern on HP Changed
+- HP Changed can have custom min/max values or percentages
+
+## Prerequisites
+- [FFXIV QuickLauncher](https://github.com/goatcorp/FFXIVQuickLauncher).
+- [Intiface Desktop](https://github.com/intiface/intiface-desktop) (DON'T USE THE INTIFACE CENTRAL)
+
+
+## Installation
+1. Launch your game, open `/xlplugins`, go to the settings (bottom left) and in the `Experimental` tab.
+2. Under `Custom Plugin Repositories` add the following url `https://raw.githubusercontent.com/kaciexx/FFXIV_Vibe_Plugin/master/repo.json` and press the + icon.
+3. Press the `Save and close` button on the bottom left.
+
+Now you should be able to see `FFXIV Vibe Plugin`. Click install and enjoy.
+
+## How to use
+1. Start `Intiface` and click on `Start Server`. Power on your device, make sure it is connected to Intiface.
+2. In the game. Type: `/fvp`. You should see the configuration panel.
+3. Press the `Connect` button.
+
+Well done !
+
+You have now FFXIV connected to Intiface. Now you can connect your device to Intiface and you
+should be able to use them with FFXIV Vibe Plugin.
+
+![ingame](./Docs/screenshot.png)
+
+## Our TODO
+Our current ideas and feedbacks are in: [TODO List](./Docs/TODO.md)
+
+A **profile selector (in game)** is scheduled to be developed. But since the
+begining of this project (28 Apr 2020), we have only reached a donation marker of
+20$. After so much effort, this plugin is not our priority anymore since we can
+not make a living from it.
+
+
+## Build yourself
+You can build yourself, instructions are here: [Build yourself](./Docs/BUILD.md)
+
+## USB Dongle vs Lovense Dongle vs Other
+We recommend you to use a bluetooth dongle. Here is the one we are using: [TP-Link Nano USB Dongle Bluetooth 5.0](https://www.amazon.fr/gp/product/B09C25VRXD/ref=as_li_tl?ie=UTF8&camp=1642&creative=6746&creativeASIN=B09C25VRXD&linkCode=as2&tag=kaciexx-21&linkId=8b6c8c6e693ab549216c2dacad34e03b)
+
+## Tested devices
+- Microsoft XBox Controller
+- Lovense (*please use bluetooth and not the lovense dongle*):
+ Nora, Hush, Domi, Ferri, Diamo, Edge 2, Gush
+
+## FAQ
+### Troubleshooting
+Make sure you have the [intiface-desktop](https://github.com/intiface/intiface-desktop) and not the new Intiface Central.
+1. Make sure your toy is not connected to another device (eg: your phone, your browser...). Disable the bluetooth on your phone.
+2. Make sure the addon is correctly installed (check the installation process again).
+3. Make sure you have the latest version.
+4. Upgrade your Intiface by clicking and installing any updates (`Settings` tab).
+5. Make sure the Intiface is up and running. Go to `Server status` > `Start Server`. You must have one green icon and one red icon on the top right side of the window.
+6. Ingame, make sure the addon is connected to Intiface. Click on `connect` (in the `Connect` tab). Now, go back to Intiface. You should have 2 green icons on the top right side of the window.
+7. Ingame, make sure the IP is either `127.0.0.1` or `0.0.0.0` or your real internal IP (eg: 192.168.1.250)
+8. Ingame and on Intiface: make sure you are using the same `port` **on both sides**. You can try changing it to something
+else **on both sides**.
+
+### My device is not working correctly
+Please make sure to test both Bluetooth and the dongle of the device. Choose the one that works best for you.
+
+### My X-Box Controller is not working well
+This is not related to this plugin. You probably should not use Bluetooth.
+
+### My Lovense Nora is not doing rotations
+Please stop using Lovense Dongle. Connect using the Lovense Connect or bluetooth. If you don't have bluetooth
+please buy a bluetooth 5.0 dongle on amazon for 20$.
+
+### The plugin does not connect to Intiface
+Please make sure you are doing it right.
+Make sure you have the [intiface-desktop](https://github.com/intiface/intiface-desktop) and not the new Intiface Central.
+1. Open Intiface and click on the top right side **red** icon.
+2. Uncheck everything but not *WebSocket* and *Bluetooth*. WebSocket should have the following text: "on [All Interfaces]:12345"
+3. Click on Start Server (now you should have one *green* icon and one *red* icon on the top right side).
+4. Go to the plugin and click connect (you should have two *green* icons).
+If this is not working: please try change the IP Address to 127.0.0.1 or your computer IP Address. Also make sure the port
+is 12345 or correspond to the one in Intiface.
+
+### The device disconnect every now and then.
+Please make sure to follow those steps before asking for help:
+1. Disable all triggers.
+2. Create a new and very simple trigger (eg: vibration on a message). **Make sure it is correctly working**.
+3. Wait twice the amount of time needed to have the issue again. (eg: if it was around 30min, then wait 60min or more).
+
+If it works, then it's a trigger issue from one you have created. If not:
+1. **Don't stop** the game, **don't stop** Intiface.
+2. Turn **off and on** your controller device.
+3. Let it reconnect to intiface (without restarting intiface app).
+4. Test your trigger again.
+If it works, then it probably a bluetooth issue. Nothing we can do about.
+
+### How do I share my configuration
+You can copy/past the file located at: `%AppData%\XIVLauncher\pluginConfigs\FFXIV_Vibe_Plugin.json`.
+Be aware: this will overrides everything.
+
+
+# Discord
+- [This plugin discord](https://discord.gg/JnCGxa3gGa)
+- [Ms. Tress #discussion](https://discord.gg/fx5pABsE)
+
+# Donation & Donors
+Donation link: https://paypal.me/kaciedev
+Please concider doing a small donation if you like this plugin. We worked a lot, gave a lots of free nights to design it, listening to everything people wanted and doing the implementation.
+
+Thanks to: Maple (20$), May B (20$), Iris K (20$), PM (1.90$)
diff --git a/repo.json b/repo.json
new file mode 100644
index 0000000..60dbfc7
--- /dev/null
+++ b/repo.json
@@ -0,0 +1,25 @@
+[
+ {
+ "Author": "Kaciexx",
+ "Name": "FFXIV Vibe Plugin",
+ "Description": "Plugin that let you vibe your controller or toys",
+ "InternalName": "FFXIV_Vibe_Plugin",
+ "AssemblyVersion": "1.7.0.0",
+ "RepoUrl": "https://github.com/kaciexx/FFXIV_Vibe_Plugin",
+ "ApplicableVersion": "any",
+ "Tags": [
+ "vibe",
+ "vibration",
+ "wave"
+ ],
+ "DalamudApiLevel": 7,
+ "IconUrl": "https://github.com/kaciexx/FFXIV_Vibe_Plugin/raw/master/Data/logo.png",
+ "IsHide": "False",
+ "IsTestingExclusive": "False",
+ "LastUpdated": 1662225133,
+ "DownloadCount": 2850,
+ "DownloadLinkInstall": "https://github.com/kaciexx/FFXIV_Vibe_Plugin/releases/download/v1.7.0.0/FFXIV_Vibe_Plugin_v1.7.0.0.zip",
+ "DownloadLinkTesting": "https://github.com/kaciexx/FFXIV_Vibe_Plugin/releases/download/v1.7.0.0/FFXIV_Vibe_Plugin_v1.7.0.0.zip",
+ "DownloadLinkUpdate": "https://github.com/kaciexx/FFXIV_Vibe_Plugin/releases/download/v1.7.0.0/FFXIV_Vibe_Plugin_v1.7.0.0.zip"
+ }
+]