diff --git a/SamplePlugin.sln b/CommandReference.sln similarity index 88% rename from SamplePlugin.sln rename to CommandReference.sln index 8212bb8..4da8df6 100644 --- a/SamplePlugin.sln +++ b/CommandReference.sln @@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.0.29709.97 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SamplePlugin", "SamplePlugin\SamplePlugin.csproj", "{13C812E9-0D42-4B95-8646-40EEBF30636F}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommandReference", "CommandReference\CommandReference.csproj", "{13C812E9-0D42-4B95-8646-40EEBF30636F}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/SamplePlugin/SamplePlugin.csproj b/CommandReference/CommandReference.csproj similarity index 72% rename from SamplePlugin/SamplePlugin.csproj rename to CommandReference/CommandReference.csproj index 47d49e2..c332111 100644 --- a/SamplePlugin/SamplePlugin.csproj +++ b/CommandReference/CommandReference.csproj @@ -5,10 +5,10 @@ - 0.0.0.1 - A sample plugin. + 0.0.1.0 + A simple plugin to group and display your current commands. - https://github.com/goatcorp/SamplePlugin + https://git.zynh.me/Zynh0722/CommandReference AGPL-3.0-or-later false diff --git a/CommandReference/CommandReference.json b/CommandReference/CommandReference.json new file mode 100644 index 0000000..457bed4 --- /dev/null +++ b/CommandReference/CommandReference.json @@ -0,0 +1,8 @@ +{ + "Author": "RavenShade", + "Name": "Command Reference", + "Punchline": "A simple plugin to group and display your current commands.", + "Description": "A simple plugin to group and display your current commands. /cmdref", + "ApplicableVersion": "any", + "Tags": ["commands", "plugins"] +} diff --git a/SamplePlugin/Configuration.cs b/CommandReference/Configuration.cs similarity index 96% rename from SamplePlugin/Configuration.cs rename to CommandReference/Configuration.cs index 05efc0d..9fffcaf 100644 --- a/SamplePlugin/Configuration.cs +++ b/CommandReference/Configuration.cs @@ -2,7 +2,7 @@ using System; using Dalamud.Configuration; using Dalamud.Plugin; -namespace SamplePlugin +namespace CommandReference { [Serializable] public class Configuration : IPluginConfiguration diff --git a/SamplePlugin/Dalamud.Plugin.Bootstrap.targets b/CommandReference/Dalamud.Plugin.Bootstrap.targets similarity index 100% rename from SamplePlugin/Dalamud.Plugin.Bootstrap.targets rename to CommandReference/Dalamud.Plugin.Bootstrap.targets diff --git a/SamplePlugin/Plugin.cs b/CommandReference/Plugin.cs similarity index 95% rename from SamplePlugin/Plugin.cs rename to CommandReference/Plugin.cs index 56346db..9650cba 100644 --- a/SamplePlugin/Plugin.cs +++ b/CommandReference/Plugin.cs @@ -6,9 +6,9 @@ using Dalamud.IoC; using Dalamud.Plugin; using Dalamud.Plugin.Services; using Dalamud.Utility; -using SamplePlugin.Windows; +using CommandReference.Windows; -namespace SamplePlugin +namespace CommandReference { public sealed class Plugin : IDalamudPlugin { @@ -19,7 +19,7 @@ namespace SamplePlugin private DalamudPluginInterface pluginInterface { get; set; } = null!; private ICommandManager commandManager { get; init; } public Configuration configuration { get; init; } - internal WindowSystem windowSystem = new("SamplePlugin"); + internal WindowSystem windowSystem = new("CommandReference"); private ConfigWindow ConfigWindow { get; init; } private MainWindow MainWindow { get; init; } diff --git a/SamplePlugin/Windows/ConfigWindow.cs b/CommandReference/Windows/ConfigWindow.cs similarity index 96% rename from SamplePlugin/Windows/ConfigWindow.cs rename to CommandReference/Windows/ConfigWindow.cs index b089a17..05e5b43 100644 --- a/SamplePlugin/Windows/ConfigWindow.cs +++ b/CommandReference/Windows/ConfigWindow.cs @@ -3,7 +3,7 @@ using System.Numerics; using Dalamud.Interface.Windowing; using ImGuiNET; -namespace SamplePlugin.Windows; +namespace CommandReference.Windows; public class ConfigWindow : Window, IDisposable { diff --git a/SamplePlugin/Windows/MainWindow.cs b/CommandReference/Windows/MainWindow.cs similarity index 97% rename from SamplePlugin/Windows/MainWindow.cs rename to CommandReference/Windows/MainWindow.cs index f2094ce..582fa03 100644 --- a/SamplePlugin/Windows/MainWindow.cs +++ b/CommandReference/Windows/MainWindow.cs @@ -4,7 +4,7 @@ using Dalamud.Interface.Internal; using Dalamud.Interface.Windowing; using ImGuiNET; -namespace SamplePlugin.Windows; +namespace CommandReference.Windows; public class MainWindow : Window, IDisposable { diff --git a/SamplePlugin/packages.lock.json b/CommandReference/packages.lock.json similarity index 100% rename from SamplePlugin/packages.lock.json rename to CommandReference/packages.lock.json diff --git a/README.md b/README.md index 572eb9a..99e4a0b 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,12 @@ To begin, [clone this template repository][new-repo] to your own GitHub account. Be sure to also check out the [Dalamud Developer Docs][dalamud-docs] for helpful information about building your own plugin. The Developer Docs includes helpful information about all sorts of things, including [how to submit][submit] your newly-created plugin to the official repository. Assuming you use this template repository, the provided project build configuration and license are already chosen to make everything a breeze. -[new-repo]: https://github.com/new?template_name=SamplePlugin&template_owner=goatcorp [dalamud-docs]: https://dalamud.dev [submit]: https://dalamud.dev/plugin-development/plugin-submission ### Prerequisites -SamplePlugin assumes all the following prerequisites are met: +CommandReference assumes all the following prerequisites are met: - XIVLauncher, FINAL FANTASY XIV, and Dalamud have all been installed and the game has been run with Dalamud at least once. - XIVLauncher is installed to its default directories and configurations. @@ -45,22 +44,22 @@ SamplePlugin assumes all the following prerequisites are met: ### Building -1. Open up `SamplePlugin.sln` in your C# editor of choice (likely [Visual Studio 2022](https://visualstudio.microsoft.com) or [JetBrains Rider](https://www.jetbrains.com/rider/)). +1. Open up `CommandReference.sln` in your C# editor of choice (likely [Visual Studio 2022](https://visualstudio.microsoft.com) or [JetBrains Rider](https://www.jetbrains.com/rider/)). 2. Build the solution. By default, this will build a `Debug` build, but you can switch to `Release` in your IDE. -3. The resulting plugin can be found at `SamplePlugin/bin/x64/Debug/SamplePlugin.dll` (or `Release` if appropriate.) +3. The resulting plugin can be found at `CommandReference/bin/x64/Debug/CommandReference.dll` (or `Release` if appropriate.) ### Activating in-game 1. Launch the game and use `/xlsettings` in chat or `xlsettings` in the Dalamud Console to open up the Dalamud settings. - - In here, go to `Experimental`, and add the full path to the `SamplePlugin.dll` to the list of Dev Plugin Locations. + - In here, go to `Experimental`, and add the full path to the `CommandReference.dll` to the list of Dev Plugin Locations. 2. Next, use `/xlplugins` (chat) or `xlplugins` (console) to open up the Plugin Installer. - - In here, go to `Dev Tools > Installed Dev Plugins`, and the `SamplePlugin` should be visible. Enable it. + - In here, go to `Dev Tools > Installed Dev Plugins`, and the `CommandReference` should be visible. Enable it. 3. You should now be able to use `/pmycommand` (chat) or `pmycommand` (console)! Note that you only need to add it to the Dev Plugin Locations once (Step 1); it is preserved afterwards. You can disable, enable, or load your plugin on startup through the Plugin Installer. ### Reconfiguring for your own uses -Basically, just replace all references to `SamplePlugin` in all of the files and filenames with your desired name, then start building the plugin of your dreams. You'll figure it out 😁 +Basically, just replace all references to `CommandReference` in all of the files and filenames with your desired name, then start building the plugin of your dreams. You'll figure it out 😁 -Dalamud will load the JSON file (by default, `SamplePlugin/SamplePlugin.json`) next to your DLL and use it for metadata, including the description for your plugin in the Plugin Installer. Make sure to update this with information relevant to _your_ plugin! +Dalamud will load the JSON file (by default, `CommandReference/CommandReference.json`) next to your DLL and use it for metadata, including the description for your plugin in the Plugin Installer. Make sure to update this with information relevant to _your_ plugin! diff --git a/SamplePlugin/SamplePlugin.json b/SamplePlugin/SamplePlugin.json deleted file mode 100644 index c806554..0000000 --- a/SamplePlugin/SamplePlugin.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "Author": "your name here", - "Name": "Sample Plugin", - "Punchline": "A short one-liner that shows up in /xlplugins.", - "Description": "A description that shows up in /xlplugins. List any major slash-command(s).", - "ApplicableVersion": "any", - "Tags": [ - "sample", - "plugin", - "goats" - ] -}